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

Ondrej Zizka (JIRA) jira-events at lists.jboss.org
Thu Apr 5 09:08:48 EDT 2012


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

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

Does this look like a valid list?

{code:xml}
<include>asm.asm:*</include>
<include>ch.qos.cal10n :*</include>
<include>com.sun.xml.bind:*</include>
<include>com.sun.xml.messaging.saaj:*</include>
<include>javaee.api:*</include>
<include>javax.activation.api:*</include>
<include>javax.activation.api :*</include>
<include>javax.annotation.api:*</include>
<include>javax.api:*</include>
<include>javax.api :*</include>
<include>javax.ejb.api:*</include>
<include>javax.el.api:*</include>
<include>javax.enterprise.api:*</include>
<include>javax.enterprise.deploy.api:*</include>
<include>javax.inject.api:*</include>
<include>javax.interceptor.api:*</include>
<include>javax.jms.api:*</include>
<include>javax.jms.api :*</include>
<include>javax.jws.api:*</include>
<include>javax.mail.api:*</include>
<include>javax.management.j2ee.api:*</include>
<include>javax.persistence.api:*</include>
<include>javax.resource.api:*</include>
<include>javax.rmi.api:*</include>
<include>javax.security.auth.message.api:*</include>
<include>javax.security.jacc.api:*</include>
<include>javax.servlet.api:*</include>
<include>javax.servlet.jsp.api:*</include>
<include>javax.servlet.jstl.api:*</include>
<include>javax.transaction.api:*</include>
<include>javax.validation.api:*</include>
<include>javax.ws.rs.api:*</include>
<include>javax.xml.bind.api:*</include>
<include>javax.xml.registry.api:*</include>
<include>javax.xml.rpc.api:*</include>
<include>javax.xml.soap.api:*</include>
<include>javax.xml.stream.api:*</include>
<include>javax.xml.ws.api:*</include>
<include>net.jcip:*</include>
<include>org.antlr:*</include>
<include>org.apache.commons.collections:*</include>
<include>org.apache.commons.configuration:*</include>
<include>org.apache.commons.lang:*</include>
<include>org.apache.commons.logging:*</include>
<include>org.apache.cxf:*</include>
<include>org.apache.juddi.juddi-client:*</include>
<include>org.apache.juddi.uddi-ws:*</include>
<include>org.apache.log4j:*</include>
<include>org.apache.santuario.xmlsec:*</include>
<include>org.apache.xalan:*</include>
<include>org.apache.xerces:*</include>
<include>org.codehaus.woodstox:*</include>
<include>org.dom4j:*</include>
<include>org.hibernate:*</include>
<include>org.hibernate.envers:*</include>
<include>org.infinispan:*</include>
<include>org.jacorb:*</include>
<include>org.javassist:*</include>
<include>org.jaxen:*</include>
<include>org.jboss.as.jacorb:*</include>
<include>org.jboss.as.jpa.hibernate:*</include>
<include>org.jboss.as.messaging:*</include>
<include>org.jboss.as.protocol:*</include>
<include>org.jboss.as.web:*</include>
<include>org.jboss.classfilewriter:*</include>
<include>org.jboss.common-core:*</include>
<include>org.jboss.dmr:*</include>
<include>org.jboss.ejb-client:*</include>
<include>org.jboss.jandex:*</include>
<include>org.jboss.jboss-transaction-spi:*</include>
<include>org.jboss.jts:*</include>
<include>org.jboss.logging:*</include>
<include>org.jboss.logging :*</include>
<include>org.jboss.logmanager:*</include>
<include>org.jboss.marshalling:*</include>
<include>org.jboss.marshalling.river:*</include>
<include>org.jboss.modules:*</include>
<include>org.jboss.netty:*</include>
<include>org.jboss.remoting3:*</include>
<include>org.jboss.resteasy.resteasy-jaxrs:*</include>
<include>org.jboss.sasl:*</include>
<include>org.jboss.security.xacml:*</include>
<include>org.jboss.threads:*</include>
<include>org.jboss.vfs:*</include>
<include>org.jboss.ws.api:*</include>
<include>org.jboss.ws.cxf.jbossws-cxf-client:*</include>
<include>org.jboss.ws.jaxws-client:*</include>
<include>org.jboss.ws.native.jbossws-native-core:*</include>
<include>org.jboss.xnio:*</include>
<include>org.jboss.xnio.nio:*</include>
<include>org.jgroups:*</include>
<include>org.joda.time:*</include>
<include>org.omg.api:*</include>
<include>org.picketbox:*</include>
<include>org.slf4j:*</include>
<include>org.slf4j.impl:*</include>
<include>sun.jdk:*</include>
{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: Ondrej Zizka
>             Fix For: 7.1.2.Final-redhat1
>
>         Attachments: packages.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