RFR: 8152818: Javadoc must support module options supported by javac.

Martin Buchholz martinrb at google.com
Sat Apr 16 22:32:10 UTC 2016


On Fri, Apr 15, 2016 at 8:17 AM, Kumar Srinivasan
<kumar.x.srinivasan at oracle.com> wrote:
>
> Martin,
>
> The bug  8152818 was pushed last night, below is a recipe
> to build  jsr166's API doc.  Please note, this is not an  optimal
> solution, and also encountered a javac issue JDK-8154152,
> also we are in discussion on a simpler method to address your
> jsr166  and other similar use cases that have been brought to
> our attention. Please check if the output is what you expect, I
> did not have time to go through the output.
>
> Thanks
> Kumar
>
> JDKDIR=<jdk_forest_dir>
> JSR166_SRC=./jsr166/src/java.base
> JDK_SRC=$JDKDIR/jdk/src/*/share/classes
> CORBA_SRC=$JDKDIR/corba/src/*/share/classes
> LT_SRC=$JDKDIR/langtools/src/*/share/classes
> PLAT_SRC=$JDKDIR/jdk/src/*/unix/classes
> GEN_SRC=$JDKDIR/build/linux-x86_64-normal-server-release/support/gensrc/*
> JAVA_HOME=$JDKDIR/build/linux-x86_64-normal-server-release/images/jdk
>
> JDK9_SRC=$JDK_SRC:$CORBA_SRC:$LT_SRC:$PLAT_SRC:$GEN_SRC
>
> $JAVA_HOME/bin/javadoc -d  javadoc-out \
>   -tag 'apiNote:a:API Note:' \
>   -tag 'implSpec:a:Implementation Requirements:' \
>   -tag 'implNote:a:Implementation Note:' \
>   -tag 'jvms:a:See <cite> The Java™ Virtual Machine
> Specification</cite>:' \
>   -tag 'jls:a:See <cite> The Java™ Language Specification</cite>:' \
>   -modulesourcepath $JSR166_SRC:$JDK9_SRC \
>   java.util \
>   java.util.concurrent \
>   java.util.concurrent.locks \
>   java.util.concurrent.atomic

I tried and failed to get any variant of the above to produce any
output at all :(
But I didn't try that hard, because the above appears to try to
produce docs for all of java.util, and we are only interested in a
small subset of java.util.  So we have traditionally provided javadoc
an explicit list of files as input, and want to continue doing that.

I tried a bunch of experiments; details in subsequent messages.


More information about the javadoc-dev mailing list