RFR: 8285488: Improve DocFinder [v4]

Pavel Rappo prappo at openjdk.org
Mon Nov 14 16:55:51 UTC 2022


On Fri, 28 Oct 2022 20:32:41 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Pavel Rappo has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 49 commits:
>> 
>>  - refactor: improve error handling
>>  - refactor: clarify, reuse, simplify, clean up
>>  - refactor: pass Utils & BaseConfiguration to taglet
>>    
>>    This simplifies lots of methods. Later this could be done for other
>>    taglets too.
>>  - refactor: better code comments
>>  - refactor: add more relevant excerpts from JLS
>>  - fix: introduce more control to search
>>    
>>    This is done for the sake of `@throws`. Two convenience methods are
>>    added to assist migration from Optional with minimal change to
>>    DocFinder call sites.
>>    
>>    This solves 8295800: When searching documentation for an exception,
>>    don't jump over methods that don't mention that exception.
>>  - refactor: clean up ThrowsTaglet
>>  - Merge branch 'master' into HEAD
>>  - fix: test failed due to filesystem handling issues
>>    
>>    Filed 8295543 to track that filesystem issue and fixed the test to make
>>    sure the package cannot be confused with the type parameter, whose
>>    name is not pertinent to the test anyway.
>>  - Merge branch 'master' into 8285488
>>  - ... and 39 more: https://git.openjdk.org/jdk/compare/628820f4...c2db1ae6
>
> test/langtools/jdk/javadoc/doclet/testThrowsInheritance/pkg/Abstract.java line 32:
> 
>> 30:     abstract void method() throws NullPointerException;
>> 31: 
>> 32:     // NOTE: Not sure why this test suggests that IndexOutOfBoundsException
> 
> I'm guessing there is nothing in the history of this file to explain it.
> 
> Given the presumably long-standing nature of the code, I'd be inclined to change `<em>should not for bug-compatibility</em>` to just `not`. and then simplify your comment below accordingly.
> 
> This file must be associated with a test class, containing `@test` and theoretically a `@bug` number. Is there any info in the JBS issue for that bug?

The associated test class: test/langtools/jdk/javadoc/doclet/testThrowsInheritance/TestThrowsTagInheritance.java

-------------

PR: https://git.openjdk.org/jdk/pull/10746


More information about the javadoc-dev mailing list