[jboss-jira] [JBoss JIRA] (AS7-582) Create aggregated JBoss AS Javadoc.
Ondrej Zizka (JIRA)
jira-events at lists.jboss.org
Mon Apr 16 14:21:19 EDT 2012
[ https://issues.jboss.org/browse/AS7-582?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12684652#comment-12684652 ]
Ondrej Zizka commented on AS7-582:
----------------------------------
I can't find a way to get javax.* into the indexes of Javadoc. Seems like it's "hardcoded" into the javadoc tool itself.
> 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
More information about the jboss-jira
mailing list