RFR: 8251496: Fix doclint warnings in jdk.net.httpserver [v3]

Chris Hegarty chegar at openjdk.java.net
Wed Sep 9 14:22:43 UTC 2020


On Wed, 9 Sep 2020 13:29:05 GMT, Roger Riggs <rriggs at openjdk.org> wrote:

>> Patrick Concannon has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8251496: reworded abstract cstr comments; removed unnecessary punctuation
>
> The @param and @return lines that start with a capital letter seem out of place.
> The contents of most @tags are usually phrases without capitalization or period.

@RogerRiggs There are many many formatting and cleanup tasks that could be done to this particular code. My advise to
Patrick was (and continues to be) to just focus on the particular issue at hand - clean up the doclint warnings. Other
annoyances can be fixed up later during another pass.  This issue is already overloaded with cleanup and semantic spec
changes. It will just increase the cognitive complexity to continue to fix (arguably) unrelated annoyances.

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

PR: https://git.openjdk.java.net/jdk/pull/81


More information about the net-dev mailing list