XDoclet has a nice feature that I think we should use. Put @todo tags in
your javadacs and xdoclet will generate a nice html report like the tests
report. This beats FIXME hands down.
Here's and example of usage from xdoclet (which uses this feature on
itself)
/**
* @author Jerome Bernard ([EMAIL PROTECTED])
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created 31 January 2002
* @version $Revision: 1.4 $
* @todo attributes - XXX: Does this need to be synchronized?
* @todo ifIsGetterMethod, ifIsSetterMethod - TODO: There is a big
overlap
* here with stuff in ejb - have a look.
*/
This is class level javadoc, it also works for method and field javadoc.
Here is the ant target from the xdoclet build file
<!-- ========================================= -->
<!-- generate todo-list from on @info:todo tags -->
<!-- ========================================= -->
<target name="todo" depends="prepare">
<taskdef
name="todo"
classname="xdoclet.doc.DocumentDocletTask"
classpath="../core/dist/lib/${name}.jar;../lib/ant.jar;../lib/log4j.jar"
/>
<path id="todo.classpath">
<pathelement path="../core/dist/lib/${name}.jar" />
<pathelement path="../lib/ant.jar" />
<pathelement path="$../lib/log4j.jar" />
<pathelement path="${java.class.path}" />
</path>
<todo
sourcepath="${src.dir}"
destdir="${build.dir}/todo"
classpathref="todo.classpath"
>
<fileset dir="${src.dir}">
<include name="**/*.java" />
</fileset>
<info/>
</todo>
</target>
If no one objects I would like it if jason could adapt this to our build
file structure and include it in all the build files. Perhaps we could ask
Chris Kimpton to run this task every night along with the tests.
btw I believe ant is starting to use this also.
Thanks
david jencks
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/jboss-development
