[jboss-jira] [JBoss JIRA] (AS7-582) Create aggregated JBoss AS Javadoc.

[Ondrej Zizka (JIRA)]

    [ https://issues.jboss.org/browse/AS7-582?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12685119#comment-12685119 ] 

Ondrej Zizka commented on AS7-582:
----------------------------------

Getting a NPE from javadoc tool...

{code}
[ERROR] /home/ondra/work/AS7/tmp-src-as7/org/jboss/as/controller/client/impl/package-info.java:28: warning - Tag @link: reference not found: org.jboss.as.controller.client core JBoss AS management client API
[ERROR] java.lang.NullPointerException
[ERROR] at com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageUse(PackageUseWriter.java:180)
[ERROR] at com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageList(PackageUseWriter.java:124)
[ERROR] at com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageUse(PackageUseWriter.java:110)
[ERROR] at com.sun.tools.doclets.formats.html.PackageUseWriter.generatePackageUseFile(PackageUseWriter.java:99)
[ERROR] at com.sun.tools.doclets.formats.html.PackageUseWriter.generate(PackageUseWriter.java:78)
[ERROR] at com.sun.tools.doclets.formats.html.ClassUseWriter.generate(ClassUseWriter.java:116)
[ERROR] at com.sun.tools.doclets.formats.html.HtmlDoclet.generateOtherFiles(HtmlDoclet.java:92)
[ERROR] at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:122)
[ERROR] at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
[ERROR] at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
[ERROR] at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
[ERROR] at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[ERROR] at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
[ERROR] at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
[ERROR] at java.lang.reflect.Method.invoke(Method.java:597)
[ERROR] at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
[ERROR] at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
[ERROR] at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
[ERROR] at com.sun.tools.javadoc.Start.begin(Start.java:128)
[ERROR] at com.sun.tools.javadoc.Main.execute(Main.java:41)
[ERROR] at com.sun.tools.javadoc.Main.main(Main.java:31)
{code}
                
> Create aggregated JBoss AS Javadoc.
> -----------------------------------
>
>                 Key: AS7-582
>                 URL: https://issues.jboss.org/browse/AS7-582
>             Project: Application Server 7
>          Issue Type: Sub-task
>          Components: Build System
>            Reporter: David Lloyd
>            Assignee: Ondrej Zizka
>             Fix For: 7.1.2.Final-redhat1
>
>         Attachments: convertModuleNameToGroupID.xsl, packages.tmp2.txt
>
>
> Identify artifacts corresponding to "supported" API modules.  Generate aggregated JavaDoc by fetching the source JAR for each API artifact.
> Enable APIViz if possible; use JBoss.org theme if possible.
> Javadoc'd packages should be grouped by API.
> It is also important that JDK classes are properly linked.  This might mean linking to oracle's doc site for JavaSE like many projects do, or perhaps using locally-generated javadoc from OpenJDK perhaps.
> Just to keep info on how to:
> {code:xml}
>                     <plugin>
>                         <groupId>org.apache.maven.plugins</groupId>
>                         <artifactId>maven-javadoc-plugin</artifactId>
>                         <version>2.8.1-SNAPSHOT</version>
>                         <executions>
>                             <execution>
>                                 <id>javadocs-dist</id>
>                                 <goals><goal>aggregate-jar</goal></goals>
>                                 <phase>validate</phase>
>                                 <configuration>
>                                    <includeDependencySources>true</includeDependencySources>
>                                    <dependencySourceIncludes>
>                                        <include>org.jboss.spec.javax.servlet:*</include>
>                                        <include>org.jboss.spec.javax.ejb:*</include>
>                                        ...
>                                    </dependencySourceIncludes>
>                                 </configuration>
>                             </execution>
>                         </executions>
>                     </plugin>
> {code}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira