diff options
author | Nick Hudson <nick.hudson@isode.com> | 2011-12-16 11:16:00 (GMT) |
---|---|---|
committer | Kevin Smith <git@kismith.co.uk> | 2011-12-16 12:24:27 (GMT) |
commit | 12b1d667965556002ea0fd300a71bcdf57634e90 (patch) | |
tree | 629698229067d6952ecfba8fb9284db03bd2078b | |
parent | 2271d75139d322607f96526e2584bd5345289fee (diff) | |
download | stroke-12b1d667965556002ea0fd300a71bcdf57634e90.zip stroke-12b1d667965556002ea0fd300a71bcdf57634e90.tar.bz2 |
Add "javadoc" target to stroke build.xml file
This change adds a javadoc target to the build file for stroke, so
that you can do
% cd build/stroke
% ant javadoc
I have not updated any of the other build infrastructure (Makefile
etc.). Nor have I added any intelligence to the "javadoc" task so
that it won't bother creating documentation if the doc is already up
to date etc..
Note that I've not used the "linkoffline" directive, which means that
if you try to generate doc when the Oracle web pages are offline,
things may hang until the connection times out.
Test-information:
"ant javadoc" works as expected
"isodebuild clean -component=stroke" gets rid of any javadoc
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | build.xml | 18 |
2 files changed, 19 insertions, 0 deletions
@@ -2,6 +2,7 @@ MANIFEST.MF *\~ build/ dist/ +doc/ nbproject/ *.class isode/Makefile @@ -7,6 +7,7 @@ XMPP Library porting Swiften to Java. </description> <property name="src" location="src"/> + <property name="doc" location="doc"/> <property name="src.tests" location="test"/> <property name="test.results" location="test-results"/> <property name="build" location="build"/> @@ -75,8 +76,25 @@ <delete dir="${build}"/> <delete dir="${test.results}"/> <delete dir="${dist}"/> + <delete dir="${doc}"/> </target> + <target name="javadoc" depends="init"> + <!-- Note that this may stall if no network connection is available + to the Oracle website --> + <javadoc packagenames="com.isode.**.**" + sourcepath="${src}" + destdir="${doc}" + windowtitle="Stroke"> + <classpath> + <fileset dir="${xpp-dir}" includes="xpp.jar"/> + </classpath> + <link href="http://docs.oracle.com/javase/6/docs/api/"/> + </javadoc> + </target> + + + <target name="run" description="Run the demo" depends="dist"> <java fork="true" classname="${main-class}"> <classpath> |