User: rinkrank
Date: 02/05/28 18:54:55
Modified: . .cvsignore build-docs.xml
Log:
Added documentation system based on Velocity/Anakia, inspired from jakarta-site2
Revision Changes Path
1.4 +1 -1 xdoclet/.cvsignore
Index: .cvsignore
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/.cvsignore,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -w -r1.3 -r1.4
--- .cvsignore 28 May 2002 23:17:51 -0000 1.3
+++ .cvsignore 29 May 2002 01:54:55 -0000 1.4
@@ -1,3 +1,3 @@
build
dist
-velocity.log
\ No newline at end of file
+velocity.log*
\ No newline at end of file
1.2 +81 -30 xdoclet/build-docs.xml
Index: build-docs.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/build-docs.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- build-docs.xml 28 May 2002 23:17:51 -0000 1.1
+++ build-docs.xml 29 May 2002 01:54:55 -0000 1.2
@@ -1,11 +1,17 @@
-<project name="XDoclet Documentation" default="docs" basedir=".">
+<project name="XDoclet Documentation" default="all-docs" basedir=".">
+
<property name="xdoclet.root.dir" value="${basedir}"/>
<property file="${xdoclet.root.dir}/build.properties"/>
<!-- =================================================================== -->
- <!-- Define classpaths for XDoclet -->
+ <!-- Generate all the docs -->
+ <!-- =================================================================== -->
+ <target name="all-docs" depends="site,api,document,todo"/>
+
<!-- =================================================================== -->
- <path id="xdoclet.class.path">
+ <!-- Define classpath -->
+ <!-- =================================================================== -->
+ <path id="doc.class.path">
<fileset dir="${lib.dir}">
<include name="**/*.jar" />
</fileset>
@@ -15,28 +21,13 @@
</path>
<!-- =================================================================== -->
- <!-- Verify if Anakia is available -->
- <!-- =================================================================== -->
- <target name="prepare">
- <available
- file="${basedir}/../jakarta-site2/lib"
- property="anakia.present"
- />
- </target>
- <target depends="prepare" name="prepare-error" unless="anakia.present">
- <fail>
- You must check out the jakarta-site2 module from CVS
- </fail>
- </target>
-
- <!-- =================================================================== -->
<!-- Creates the project.xml file used by Anakia -->
<!-- =================================================================== -->
<target name="project-xml">
<taskdef
name="xdoclet"
classname="xdoclet.DocletTask"
- classpathref="xdoclet.class.path"
+ classpathref="doc.class.path"
/>
<xdoclet destdir="${xdoclet.root.dir}/xdocs/resources">
@@ -52,17 +43,14 @@
</xdoclet>
</target>
-
- <target name="docs" depends="prepare,project-xml">
- <path id="anakia.class.path">
- <fileset dir="${basedir}/../jakarta-site2/lib">
- <include name="*.jar"/>
- </fileset>
- </path>
+ <!-- =================================================================== -->
+ <!-- Creates the Web Site documentation -->
+ <!-- =================================================================== -->
+ <target name="site" depends="project-xml">
<taskdef
name="anakia"
classname="org.apache.velocity.anakia.AnakiaTask"
- classpathref="anakia.class.path"
+ classpathref="doc.class.path"
/>
<anakia
basedir="${docs.src.dir}"
@@ -73,16 +61,79 @@
excludes="**/resources/** empty.xml"
includes="**/*.xml"
lastModifiedCheck="true"
- templatePath="../jakarta-site2/xdocs/stylesheets"
+ templatePath="${docs.src.dir}/stylesheets"
>
</anakia>
- <copy todir="${docs.build.dir}/images" filtering="no">
- <fileset dir="${docs.src.dir}/images">
+ <copy todir="${docs.build.dir}" filtering="no">
+ <fileset dir="${docs.src.dir}">
<include name="**/*.gif"/>
<include name="**/*.jpeg"/>
<include name="**/*.jpg"/>
+ <include name="**/*.png"/>
+ <include name="**/*.js"/>
+ <include name="**/*.css"/>
</fileset>
</copy>
+ </target>
+
+ <!-- =================================================================== -->
+ <!-- Creates the API documentation -->
+ <!-- =================================================================== -->
+ <target name="api">
+ <mkdir dir="${docs.api.dir}"/>
+ <javadoc packagenames="${packages}"
+ sourcepath="${core.src.dir}"
+ destdir="${docs.api.dir}"
+ author="yes"
+ version="yes"
+ use="yes"
+ windowtitle="${Name} API"
+ doctitle="${Name}">
+ <classpath refid="doc.class.path"/>
+ <link href="http://java.sun.com/j2se/1.3/docs/api/"/>
+ <!--<link href="http://jakarta.apache.org/ant/manual/api/"/>-->
+ <link href="http://java.sun.com/j2ee/j2sdkee/techdocs/api/"/>
+ <link href="http://www.junit.org/junit/javadoc/3.7/"/>
+ </javadoc>
+ </target>
+
+ <!-- =================================================================== -->
+ <!-- Generate template tags documentation from source -->
+ <!-- =================================================================== -->
+ <target name="document">
+ <mkdir dir="${docs.templates.dir}"/>
+ <taskdef
+ name="document"
+ classname="xdoclet.modules.doc.DocumentDocletTask"
+ classpathref="doc.class.path"
+ />
+
+ <document destdir="${docs.templates.dir}">
+ <fileset dir="${core.src.dir}">
+ <include name="**/*TagsHandler.java" />
+ </fileset>
+
+ <documenttags/>
+ </document>
+ </target>
+
+ <!-- =================================================================== -->
+ <!-- Generate todo-list from source (@todo tags) -->
+ <!-- =================================================================== -->
+ <target name="todo">
+ <mkdir dir="${docs.todo.dir}" />
+ <taskdef name="todo"
+ classname="xdoclet.modules.doc.DocumentDocletTask"
+ classpathref="doc.class.path"
+ />
+
+ <todo destdir="${docs.todo.dir}" >
+ <fileset dir="${core.src.dir}">
+ <include name="**/*.java" />
+ </fileset>
+
+ <info/>
+ </todo>
</target>
</project>
_______________________________________________________________
Don't miss the 2002 Sprint PCS Application Developer's Conference
August 25-28 in Las Vegas -- http://devcon.sprintpcs.com/adp/index.cfm
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
