RFR: 8189706: javadoc for the Jdk APIs should summarize overridden methods with no specification changes
Tim Bell
tim.bell at oracle.com
Fri Oct 20 21:27:29 UTC 2017
Kumar-
Looks good to me as well.
/Tim
On 10/20/17 10:29, Jonathan Gibbons wrote:
> Looks good.
>
> On 10/20/2017 08:42 AM, mandy chung wrote:
>> Looks good.
>>
>> Mandy
>>
>> On 10/19/17 8:40 PM, Kumar Srinivasan wrote:
>>> Hello,
>>>
>>> Please review build change to enable the javadoc tool to produce
>>> concise API
>>> documentation for those classes that override a method without
>>> changing its
>>> specification see [2], this change simply enables that feature in the
>>> javadoc tool.
>>>
>>>
>>> diff --git a/make/Docs.gmk b/make/Docs.gmk
>>> --- a/make/Docs.gmk
>>> +++ b/make/Docs.gmk
>>> @@ -103,7 +103,8 @@
>>> # The initial set of options for javadoc
>>> JAVADOC_OPTIONS := -use -keywords -notimestamp \
>>> -serialwarn -encoding ISO-8859-1 -docencoding UTF-8
>>> -breakiterator \
>>> - -splitIndex --system none -html5 -javafx --expand-requires transitive
>>> + -splitIndex --system none -html5 -javafx --expand-requires
>>> transitive \
>>> + --override-methods=summary
>>>
>>> # Should we add DRAFT stamps to the generated javadoc?
>>> ifeq ($(VERSION_IS_GA), true)
>>>
>>> Thanks
>>> Kumar
>>>
>>>
>>> [1] https://bugs.openjdk.java.net/browse/JDK-8189706
>>> [2] https://bugs.openjdk.java.net/browse/JDK-8187386
>>
>
More information about the build-dev
mailing list