JDK 9 RFR of JDK-8031081 Use separate doclint flags for different doc bundles
Joe Darcy
joe.darcy at oracle.com
Mon Jan 6 21:16:00 UTC 2014
On 01/06/2014 12:55 PM, Chris Hegarty wrote:
> On 5 Jan 2014, at 23:30, Joe Darcy <joe.darcy at oracle.com> wrote:
>
>> On 01/05/2014 02:36 AM, Alan Bateman wrote:
>>> On 31/12/2013 02:07, Joe Darcy wrote:
>>>> :
>>>>
>>>> To be clear, the goal would be for "-Xdoclint:all/protected" to be used on all bundles.
>>> Is the goal also for these warnings to be fatal? If so then I just wonder about the implications (we would need to ensure that the docs build are built continuously or minimally prior to any integration into master).
>>>
>>>
>> Yes, I think such javadoc warnings should be fatal. Additionally, when an engineer is making javadoc changes, I think running the docs build should be part of the to-do list before a push.
> Sounds good to me ( I must remember to do doc builds before pushing ;-) ). In which case I’d like to go ahead and enable "-Xdoclint:all/protected” for the SCTP API docs. They are clean.
>
> diff --git a/make/Javadoc.gmk b/make/Javadoc.gmk
> --- a/make/Javadoc.gmk
> +++ b/make/Javadoc.gmk
> @@ -1142,7 +1142,7 @@
> $(SCTPAPI_OPTIONS_FILE):
> $(prep-target)
> @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
> - $(call OptionOnly,-Xdoclint:none) ; \
> + $(call OptionOnly,-Xdoclint:all/protected) ; \
> $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
> $(call OptionPair,-encoding,ascii) ; \
> $(call OptionOnly,-nodeprecatedlist) ; \
>
> -Chris.
>
>
Sounds good to me :-)
-Joe
More information about the build-dev
mailing list