User: vharcq
Date: 02/04/17 23:16:02
Modified: core/docs doclet_all.html ejb.html samples.html using.html
Log:
Move out xdoclet-generate generattion to a new ant property "addedtags" that can
take multiple comma separated tags to add to generated class javadoc.
Let ant take car of TODAY adding for example.
This permits more flexibility.
See samples build for an example.
Revision Changes Path
1.5 +26 -19 xdoclet/core/docs/doclet_all.html
Index: doclet_all.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/doclet_all.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -w -r1.4 -r1.5
--- doclet_all.html 27 Jan 2002 15:21:44 -0000 1.4
+++ doclet_all.html 18 Apr 2002 06:16:02 -0000 1.5
@@ -35,7 +35,7 @@
<TD>Specify tags that should not be automatically written to output files.
The normal behaviour is to include all @ tags from the source file to the
output files. This may cause trouble if you use cvs-like tag like
- $Revision: 1.4 $ that will be overwritten at each build and causes a
+ $Revision: 1.5 $ that will be overwritten at each build and causes a
difference for CVS even if the code himself is not changed. Example:
excludedtags="@version"<BR>
For excluded tags, ejbdoclet will generate an hardcoded tag. Example:
@@ -43,6 +43,13 @@
<TD>No</TD>
</tr>
<tr>
+ <td valign="top">addedtags</td>
+ <td valign="top">Add some JavaDoc tags (or comments) to the generated classes.
+A special case is @xdoclet-generated. If this is included, ejbdoclet will not
consider
+the file if it is by error in the <i>fileset</i> of the ejbdoclet task.</td>
+ <td>No</td>
+</tr>
+ <tr>
<TD>packagenames</TD>
<TD>Comma separated list of package files (with terminating wildcard).</TD>
<TD VALIGN="middle" rowspan="2">One or the other</TD>
1.30 +20 -7 xdoclet/core/docs/Attic/ejb.html
Index: ejb.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/Attic/ejb.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -w -r1.29 -r1.30
--- ejb.html 18 Feb 2002 22:24:51 -0000 1.29
+++ ejb.html 18 Apr 2002 06:16:02 -0000 1.30
@@ -47,6 +47,10 @@
<taskdef name="ejbdoclet"
classname="xdoclet.ejb.EjbDocletTask"
classpath="${xdoclet.jar.path};${lib.dir}/ejb.jar;${lib.dir}/log4j.jar"/><br>
<br>
+ <tstamp><br>
+ <format property="TODAY"
pattern="d-MM-yy" /><br>
+ </tstamp><br>
+<br>
<ejbdoclet sourcepath="${java.dir}"<br>
destdir="${generated.java.dir}"<br>
@@ -55,6 +59,8 @@
excludedtags="@version,@author"<br>
+addedtags="@xdoclet-generated at ${TODAY}"<br>
+
ejbspec="2.0"<br>
force="${xdoclet.force}"><br>
@@ -133,12 +139,19 @@
<td valign="top">Specify tags that should not be automatically written to
output files. The normal behaviour is to include all @ tags from the source
file to the output files. This may cause trouble if you use cvs-like tag like
- $Revision: 1.29 $ that will be overwritten at each build and causes a
difference for
+ $Revision: 1.30 $ that will be overwritten at each build and causes a
difference for
CVS even if the code himself is not changed. Example:
excludedtags="@version"<br>
For excluded tags, ejbdoclet will generate an hardcoded tag. Example:
@version XDOCLET 1.0</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
+ <td valign="top">addedtags</td>
+ <td valign="top">Add some JavaDoc tags (or comments) to the generated classes.
+A special case is @xdoclet-generated. If this is included, ejbdoclet will not
consider
+the file if it is by error in the <i>fileset</i> of the ejbdoclet task.</td>
+ <td align="center" valign="top">No</td>
+</tr>
+ <tr>
<td valign="top">mergedir</td>
<td valign="top">Merge directory where ejbdoclet looks for files to be
merged with generated files.</td>
1.3 +6 -0 xdoclet/core/docs/samples.html
Index: samples.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/samples.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -r1.2 -r1.3
--- samples.html 27 Dec 2001 16:51:43 -0000 1.2
+++ samples.html 18 Apr 2002 06:16:02 -0000 1.3
@@ -6,6 +6,10 @@
<taskdef name="ejbdoclet"
classname="xdoclet.ejb.EjbDocletTask"
classpath="${xdoclet.jar.path};${lib.dir}/log4j.jar"/><br>
<br>
+ <tstamp><br>
+ <format property="TODAY"
pattern="d-MM-yy" /><br>
+ </tstamp><br>
+<br>
<ejbdoclet sourcepath="${java.dir}"<br>
destdir="${generated.java.dir}"<br>
@@ -13,6 +17,8 @@
classpathref="project.class.path"<br>
excludedtags="@version,@author"<br>
+
+addedtags="@xdoclet-generated at ${TODAY}"<br>
ejbspec="2.0"<br>
1.9 +5 -0 xdoclet/core/docs/using.html
Index: using.html
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/docs/using.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -w -r1.8 -r1.9
--- using.html 7 Mar 2002 22:35:46 -0000 1.8
+++ using.html 18 Apr 2002 06:16:02 -0000 1.9
@@ -79,11 +79,16 @@
<taskdef name="ejbdoclet"
classname="xdoclet.ejb.EjbDocletTask"
classpath="${xdoclet.jar.path};${log4j.jar.path};${ant.jar.path}" />
+<tstamp>
+ <format property="TODAY" pattern="d-MM-yy" />
+</tstamp>
+
<ejbdoclet
sourcepath="${java.dir}"
destdir="${generated.java.dir}"
classpathref="project.class.path"
excludedtags="@version,@author"
+ addedtags="@xdoclet-generated at ${TODAY}"
ejbspec="2.0"
force="${xdoclet.force}">
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
