building javadoc with modules

Jonathan Gibbons jonathan.gibbons at oracle.com
Thu Aug 30 21:04:24 UTC 2018 

Justin,

It seems there are two forms of src.zip out in the wild.  My previous 
response was based on using a src.zip that is essentially just a zip of 
the contents of appropriate OpenJDK repo.  As such, it has top level 
directories like "make", "src", "test", and the src/ directory does not 
contain any of the generated sources.

This response is based on the other form of src.zip, which is 
platform-specific and just contains all the source files for a build. 
The entries in this zip are of the form <module>/<package>/<class>.java

The basic form of the javadoc command is this:

    /opt/jdk/1.9.0/bin/javadoc \
         --module-source-path 'play/javadoc-demo/src/*' \
         -d play/javadoc-demo/api \
         -quiet \
         -Xmaxerrs 10000 \
         -Xmaxwarns 10000 \
         --expand-requires transitive \
         --module java.se

Compared to my notes from yesterday, this has a simplified 
`--module-source path`, and has additional options `-quiet`, 
`-Xmaxerrs`, `-Xmaxwarns`.
The argument to module-source-path should be the path to the expanded 
zip file, followed by '/*' (or `\*` on Windows.) You probably need to 
quote the argument to prevent your shell expanding the '*': that is 
important.

This command should run to completion, although it generates (for me) 
1704 errors and 918 warnings.

The warnings are embarrassing, and are mostly about bad javadoc comments.

The errors are all about custom tags being used in the documentation 
comments.  You can provide definitions for most of these on the javadoc 
command line, like this:

/opt/jdk/1.9.0/bin/javadoc \
     --module-source-path 'play/javadoc-demo/src/*' \
     -d play/javadoc-demo/api \
     -quiet \
     -Xmaxerrs 10000 \
     -Xmaxwarns 10000 \
     --expand-requires transitive \
     --module java.se \
     -tag beaninfo:X \
     -tag revised:X \
     -tag since.unbundled:X \
     -tag spec:X \
     -tag specdefault:X \
     -tag Note:X \
     -tag ToDo:X \
     -tag 'apiNote:a:API Note:' \
     -tag 'implSpec:a:Implementation Requirements:' \
     -tag 'implNote:a:Implementation Note:' \
     -tag param \
     -tag return \
     -tag throws \
     -tag since \
     -tag serialData \
     -tag factory \
     -tag see \
     -tag 'jvms:a:See <cite>The Java™ Virtual Machine 
Specification</cite>:' \
     -tag 'jls:a:See <cite>The Java™ Language Specification</cite>:'

The list is taken from the JDK makefiles. That omits definitions for 3 
tags, for {@extLink}, {@incubating} and {@moduleGraph} which are handled 
by taglets (i.e. compiled source code) contained in the JDK build. With 
that extended command, the counts go down to 79 errors, 918 warnings, 
which is likely as far as we'll get without using the taglets and/or 
fixing javadoc comments.

Note that the actual JDK API documentation is generated with additional 
options, to set header and footer text containing license and other 
information.

I hope this helps.

-- Jon

On 08/29/2018 05:28 PM, Jonathan Gibbons wrote:
> Justin,
>
> This ought to be simple, but as you discovered, it isn't.
>
> I tried to generate the docs using the JDK 10 src.zip, available here:
> https://download.java.net/openjdk/jdk10/ri/openjdk-10_src.zip
>
> After ou unzip the sources, the command ought to be as simple as 
> something like the following:
>
> /opt/jdk/10/bin/javadoc \
>     --module-source-path 'openjdk/src/*/{linux,unix,share}/classes' \
>     -d api \
>     --expand-requires transitive \
>     --module java.se
>
> Here's what those lines mean:
>
> /opt/jdk/10/bin/javadoc \# path to javadoc
>     --module-source-path 'openjdk/src/*/{linux,unix,share}/classes' \# 
> specify "pattern" for location of sources
>     -d api \ # output directory
>     --expand-requires transitive \ #saves typing lots of module names
>     --module java.se # the root module name (plus its transitive 
> dependencies)
>
> Note: the combination of --module java.se --expand-requires transitive 
> will just give you the java.* modules (because java.se does not depend 
> on any jdk.* modules); if you want the JDK modules as well, you'll 
> have to list them separately,
>
> So what's the problem?
>
> If you run the command, it gives lots of "cannot find symbol" messages 
> for a comparatively small number of types. The most frequent one that 
> showed up for me was java.nio.ByteBuffer ... and therein lies the hint 
> of the problem. There is no source for java.nio.ByteBuffer in the 
> src.zip file! It turns out that for a number of classes, including 
> {Byte,Char}Buffer, Charset{De,En}coder, the source is generated as 
> part of the full JDK build.
>
> There are two possible workarounds:
>
> 1. Run the full build first, then figure out the path to the gensrc 
> directory. For my system, it is something like
>         build/linux-x86_64-normal-server-release/support/gensrc/
>     meaning that the --module-source-path option has to be something like:
>
> -module-source-path 
> 'openjdk/src/*/{linux,unix,share}/classes:build/linux-x86_64-normal-server-release/support/gensrc/*'
>
>     If you're looking to generate full docs for all of Java SE, this 
> is the recommended solution, but if you're going to build JDK, then 
> you might as well use the JDK makefiles to build the docs as well, 
> with just "make docs" or "make docs-jdk-api" or something like that.
>
> 2. The other option is much more verbose, and not recommended if 
> you're trying to generate full documentation for Java SE.
> It relies on the fact that the definitions for the missing symbols do 
> exist in JDK itself, for the right version of JDK. So you can use the 
> --patch-module option to "patch" every module you want to document 
> with its source code.  If you're looking to modify one or a few 
> modules, and generate updated docs, this may be a reasonable approach, 
> but if you're looking to generate docs for all 72 JDK modules, that's 
> a long command line! You will still need the basic 
> --module-source-path option, to keep javadoc happy and to tell it that 
> you're working in "multi-module mode", but you won't need to provide 
> the gensrc directory.
>
> The alternative is to find/use a consolidated src.zip file that (just) 
> contains all the source for your platform, and nothing else, in a 
> single simple exploded module hierarchy.
>
> -- Jon
>
>
> On 08/27/2018 06:47 PM, Justin Lee wrote:
>> I'm trying to runjavadocagainst the java9 src.zip and I have no idea 
>> how to handle the modules.  Even if I go with the classic 
>> "javadoc at sources" approach I get an error about too many modules 
>> defined. I've tried a number of variations but I can't quite seem to 
>> crack that nut.
>>
>> My latest attempt looks like this:
>>
>>     javadoc -d /tmp/javadoc9 -html5 --module \
>>      java.management.rmi \
>>      jdk.packager.services \
>>      jdk.scripting.nashorn.shell \
>>          <more module names here...> \
>>          -Xmaxerrs 1000 \
>>          @source.files
>>
>>
>>
>> Does anyone have an example of running thejavadoctool from the 
>> command line and generating docs for modularized code like this?  Thanks.
>>
>> -- 
>> You can find me on the net at:
>> http://antwerkz.com <http://antwerkz.com/> http://antwerkz.com/+
>> http://antwerkz.com/twitter http://antwerkz.com/github
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20180830/b42dd97d/attachment-0001.html>

More information about the javadoc-dev mailing list