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

[Ondrej Zizka (JIRA)]

     [ https://issues.jboss.org/browse/AS7-582?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ondrej Zizka updated AS7-582:
-----------------------------

    Description: 
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}


  was:
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}



    
> 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: Paul Gier
>             Fix For: 7.1.2.Final-redhat1
>
>
> 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