[jboss-jira] [JBoss JIRA] (AS7-582) Create JBoss AS Javadoc aggregate project

Vladimir Dosoudil (Commented) (JIRA) jira-events at lists.jboss.org
Wed Dec 7 10:24:41 EST 2011


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

Vladimir Dosoudil commented on AS7-582:
---------------------------------------

In progress, try to use https://github.com/dosoudil/jboss-as/tree/AS7-582

Generate aggregated javadoc from sources of dependecies.
It makes javadoc jars for modules but not the big one for whole AS.
Use find . -name '*-javadoc.jar' to list them when they're built.

Usage: mvn package -Pdocs

Known bug:
It's necessary to do it in two step. It's stuck on jboss-as-web module.
Please use 'mvn package -Pdocs -rf :jboss-as-web' to continue immediately.
                
> Create JBoss AS Javadoc aggregate project
> -----------------------------------------
>
>                 Key: AS7-582
>                 URL: https://issues.jboss.org/browse/AS7-582
>             Project: Application Server 7
>          Issue Type: Sub-task
>            Reporter: David Lloyd
>            Assignee: Vladimir Dosoudil
>             Fix For: 7.1.0.CR1
>
>
> 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.

--
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

        


More information about the jboss-jira mailing list