RFR: 8285488: Improve DocFinder [v4]

Jonathan Gibbons jjg at openjdk.org
Tue Nov 15 18:54:09 UTC 2022


On Fri, 28 Oct 2022 20:54:34 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/testThrowsInheritanceMatching/TestExceptionTypeMatching.java line 397:
> 
>> 395:                 }
>> 396:                 """);
>> 397:         setAutomaticCheckLinks(false); // otherwise the link checker reports that P.MyException is defined twice
> 
> What is the error here? is it a valid error or a false positive?

It's a genuine error, in the generated serialized-form.html page; we should file a bug report

Now we know that, it's OK to workaround it here ... maybe with a comment for the JBS issue

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

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


More information about the javadoc-dev mailing list