[jboss-jira] [JBoss JIRA] (AS7-582) Create JBoss AS Javadoc aggregate project
[
https://issues.jboss.org/browse/AS7-582?page=com.atlassian.jira.plugin.sy...
]
Ondrej Zizka edited comment on AS7-582 at 4/5/12 9:07 AM:
----------------------------------------------------------
{code}
echo '' > packages.tmp.txt
for i in `find build/src/main/resources/modules/ -name module.xml` ; do
FILE=`grep 'value="private"' --files-without-match $i`;
if [ "$FILE" == "" ] ; then continue; fi;
## Extract module name.
#PKG=`grep '<module name="' $FILE | sed 's#<module
name="\([^"]*\).*"#\1#' | sed 's#/>##'`;
## Strip whitespace.
#PKG=`echo $PKG | sed 's#\s*\(.*\)\s*#\1#'`
#echo "<include>$PKG:*</include>"
grep '<module name="' $FILE | sed 's#<module
name="\([^"]*\).*"#\1#' | sed 's#/\?>##' | sed
's#\s*\(.*\)\s*#\1#' >> packages.tmp.txt
done
sort packages.tmp.txt | uniq > packages.tmp2.txt
cat packages.tmp2.txt | sed 's#.*#<include>\0:*</include>#'
{code}
was (Author: ozizka):
{code}
echo '' > packages.tmp.txt
for i in `find build/src/main/resources/modules/ -name module.xml` ; do
FILE=`grep 'value="private"' --files-without-match $i`;
if [ "$FILE" == "" ] ; then continue; fi;
## Extract module name.
#PKG=`grep '<module name="' $FILE | sed 's#<module
name="\([^"]*\).*"#\1#' | sed 's#/>##'`;
## Strip whitespace.
#PKG=`echo $PKG | sed 's#\s*\(.*\)\s*#\1#'`
#echo "<include>$PKG:*</include>"
grep '<module name="' $FILE | sed 's#<module
name="\([^"]*\).*"#\1#' | sed 's#/\?>##' | sed
's#\s*\(.*\)\s*#\1#' >> packages.tmp.txt
done
sort packages.tmp.txt | uniq
{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