RFR: 8159305: Enhance the javadoc tool to support module related options

[Kumar Srinivasan]

Hi Martin,

No this does address the 166 issues, bug still open,
https://bugs.openjdk.java.net/browse/JDK-8152911

This enhancement, makes it easy for folks to generate javadocs
in a module centric manner.

To give you an example, in the existing tool, you would do something like
-modulesourcepath some-paths
java.lang java.util java.io  ....
ie. packages that constitutes  the module java.base

So now with these enhancements you can simply do this:
-modulesourcepath somepaths
--module java.base--expand-requires:public

Which will walk the module-graph documenting those modules
and packages that meet the criteria.

HTH

Kumar



> Hi Kumar,
>
> Is this intended to address the jsr166 use case (source files belong 
> to a module, but not the entire module is being processed, and not all 
> module sources are in a single tree)?
>
> Currently, jsr166 CVS docs are still broken. "ant docs" fails with
>
>   [javadoc] java.lang.AssertionError
>   [javadoc] at 
> com.sun.tools.javac.util.Assert.error(jdk.compiler at 9-ea/Assert.java:155)
>   [javadoc] at 
> com.sun.tools.javac.util.Assert.checkNull(jdk.compiler at 9-ea/Assert.java:54)
>   [javadoc] at 
> com.sun.tools.javac.code.Symtab.enterModule(jdk.compiler at 9-ea/Symtab.java:755)
>   [javadoc] at 
> com.sun.tools.javac.comp.Modules.enterModule(jdk.compiler at 9-ea/Modules.java:262)
>   [javadoc] at 
> com.sun.tools.javac.comp.Modules.enterModules(jdk.compiler at 9-ea/Modules.java:240)
>   [javadoc] at 
> com.sun.tools.javac.comp.Modules.enter(jdk.compiler at 9-ea/Modules.java:208)
>   [javadoc] at 
> com.sun.tools.javac.main.JavaCompiler.readSourceFile(jdk.compiler at 9-ea/JavaCompiler.java:816)
>   [javadoc] at 
> com.sun.tools.javac.main.JavaCompiler.readSourceFile(jdk.compiler at 9-ea/JavaCompiler.java:778)
>   [javadoc] at 
> com.sun.tools.javac.main.JavaCompiler.access$100(jdk.compiler at 9-ea/JavaCompiler.java:97)
>   [javadoc] at 
> com.sun.tools.javac.main.JavaCompiler$1.complete(jdk.compiler at 9-ea/JavaCompiler.java:339)
>   [javadoc] at 
> com.sun.tools.javac.code.ClassFinder.fillIn(jdk.compiler at 9-ea/ClassFinder.java:362)
>   [javadoc] at 
> com.sun.tools.javac.code.ModuleFinder.lambda$findSingleModule$0(jdk.compiler at 9-ea/ModuleFinder.java:206)
>   [javadoc] at 
> com.sun.tools.javac.code.Symbol.complete(jdk.compiler at 9-ea/Symbol.java:602)
>   [javadoc] at 
> com.sun.tools.javac.comp.Modules.setCompilationUnitModules(jdk.compiler at 9-ea/Modules.java:366)
>   [javadoc] at 
> com.sun.tools.javac.comp.Modules.enter(jdk.compiler at 9-ea/Modules.java:210)
>   [javadoc] at 
> jdk.javadoc.internal.tool.JavadocTool.getEnvironment(jdk.javadoc at 9-ea/JavadocTool.java:190)
>   [javadoc] at 
> jdk.javadoc.internal.tool.Start.parseAndExecute(jdk.javadoc at 9-ea/Start.java:405)
>   [javadoc] at 
> jdk.javadoc.internal.tool.Start.begin(jdk.javadoc at 9-ea/Start.java:299)
>   [javadoc] at 
> jdk.javadoc.internal.tool.Start.begin(jdk.javadoc at 9-ea/Start.java:243)
>   [javadoc] at 
> jdk.javadoc.internal.tool.Main.execute(jdk.javadoc at 9-ea/Main.java:63)
>   [javadoc] at 
> jdk.javadoc.internal.tool.Main.main(jdk.javadoc at 9-ea/Main.java:52)
>   [javadoc] javadoc: error - fatal error
>
>
> On Mon, Jun 20, 2016 at 4:18 PM, Kumar Srinivasan 
> <kumar.x.srinivasan at oracle.com <mailto:kumar.x.srinivasan at oracle.com>> 
> wrote:
>
>     Hello,
>
>     Please review the changes to fix:
>     https://bugs.openjdk.java.net/browse/JDK-8159305
>
>     The webrev is here:
>     http://cr.openjdk.java.net/~ksrini/8159305/webrev.00/
>     <http://cr.openjdk.java.net/%7Eksrini/8159305/webrev.00/>
>
>     The spec-diff is here for reference:
>     http://cr.openjdk.java.net/~ksrini/8159305/spec-diff/overview-summary.html
>     <http://cr.openjdk.java.net/%7Eksrini/8159305/spec-diff/overview-summary.html>
>
>
>     Thanks
>     Kumar
>
>

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