Author: jmesnil Date: 2009-12-07 09:53:52 -0500 (Mon, 07 Dec 2009) New Revision: 8606 Modified: trunk/build-hornetq.xml trunk/build.xml trunk/pom.xml Log: HORNETQ-186: fill in Javadocs for core API * refactor Ant's javadoc target to generate javadoc only for API and Management * generate HTML version of the source code linked to the javadoc * use apiviz to create class diagrams Modified: trunk/build-hornetq.xml =================================================================== --- trunk/build-hornetq.xml 2009-12-07 14:36:45 UTC (rev 8605) +++ trunk/build-hornetq.xml 2009-12-07 14:53:52 UTC (rev 8606) @@ -215,6 +215,8 @@ <path id="javadoc.classpath"> <path refid="jms.compilation.classpath"/> + <path refid="org.jboss.netty.classpath"/> + <path location="${thirdparty.dir}/org/jboss/apiviz/lib/apiviz.jar" /> <path location="${build.classes.dir}"/> </path> @@ -999,18 +1001,32 @@ <target name="javadoc"> - <javadoc destdir="${build.api.dir}" author="true" version="true" use="true" - windowtitle="HornetQ ${module.version}"> + <javadoc + doclet="org.jboss.apiviz.APIviz" + docletpath="${thirdparty.dir}/org/jboss/apiviz/lib/apiviz.jar" + destdir="${build.api.dir}" + additionalparam="-author -version -use -public -linksource" + windowtitle="HornetQ ${module.version}"> - <packageset dir="${src.main.dir}" defaultexcludes="yes"> - <include name="org/hornetq/**"/> + <packageset dir="${src.main.dir}" defaultexcludes="false"> + <include name="org/hornetq/core/config"/> + <include name="org/hornetq/core/client"/> + <include name="org/hornetq/core/remoting"/> + <include name="org/hornetq/core/management"/> + <include name="org/hornetq/jms"/> + <include name="org/hornetq/jms/client"/> + <include name="org/hornetq/jms/server/management"/> + <include name="org/hornetq/utils"/> </packageset> <classpath refid="javadoc.classpath"/> <doctitle><![CDATA[<h2>HornetQ ${module.version}</h2>]]></doctitle> <bottom><![CDATA[<i>Copyright &#169; 2009 Red Hat Inc. All Rights Reserved.</i>]]></bottom> - <tag name="todo" scope="all" description="To do:"/> - <group title="JMS Facade" packages="org.jboss.jms.*"/> - <group title="HornetQ Core" packages="org.hornetq.*"/> + <group title="HornetQ Core API" packages="org.hornetq.core.client, org.hornetq.core.config, org.hornetq.core.remoting, org.hornetq.utils"/> + <group title="HornetQ Management API" packages="org.hornetq.core.management"/> + <group title="JMS Facade" packages="org.hornetq.jms, org.hornetq.jms.client"/> + <group title="JMS Management API" packages="org.hornetq.jms.server.management"/> + <link href="http://java.sun.com/j2se/1.5.0/docs/api"/> + <link href="http://java.sun.com/javaee/5/docs/api/"/> </javadoc> </target> Modified: trunk/build.xml =================================================================== --- trunk/build.xml 2009-12-07 14:36:45 UTC (rev 8605) +++ trunk/build.xml 2009-12-07 14:53:52 UTC (rev 8606) @@ -107,6 +107,10 @@ <ant antfile="build-hornetq.xml" target="userdoc"/> </target> + <target name="javadoc"> + <ant antfile="build-hornetq.xml" target="javadoc"/> + </target> + <target name="validate-configuration"> <ant antfile="build-hornetq.xml" target="validate-configuration"/> </target> Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-12-07 14:36:45 UTC (rev 8605) +++ trunk/pom.xml 2009-12-07 14:53:52 UTC (rev 8606) @@ -271,6 +271,13 @@ <artifactId>jboss-ejb3-ext-api</artifactId> <version>1.0.0</version> </dependency> + + <!-- needed for javadoc graphics--> + <dependency> + <groupId>org.jboss.apiviz</groupId> + <artifactId>apiviz</artifactId> + <version>1.3.0.GA</version> + </dependency> </dependencies>