On Mon, 24 Oct 2022 21:01:30 GMT, Jonathan Gibbons <[email protected]> wrote:

>> Pavel Rappo has updated the pull request incrementally with one additional 
>> commit since the last revision:
>> 
>>   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.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ThrowsTaglet.java
>  line 124:
> 
>> 122:      * thrown exceptions and, hence, document them.
>> 123:      */
>> 124: 
> 
> Would it make sense to add a 3rd section about characteristics of `@throws` 
> tags to be taken into account, citing issues like repeatability, subtypes, 
> and inheritance?

Not sure. I'm trying to keep code documentation to a minimum, really. Ideally, 
all a maintainer would need is "Documentation Comment Specification for the 
Standard Doclet" and code. I know you are not a fan of such a style, but DRY is 
good.

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

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

Reply via email to