Doclet to generate a ToDo list

Question

Hi folks,
Anybody knows a about a doclet to generate a page with a table with ToDo list like the Doxygen \todo tag ?
Thanks in advance.

Answer 1

A regexp maybe? (assuming 1.4), I think the following will work, if your todo tags are like mine, i.e.
* @TODO A one line string.
^\s*\*\s{1,}TODO\s{1,}\(.{1,}\)$
This reads (I think, untested) start of line, then any number of white-space chars, followed by an astrix follow by one or more white space chars followed by the string "TODO" follow by one or more white space chars followed a captured group containing anything (but it has to be something), upto the end of the line.
If you want the TODO to ignore case, stick a (?i) before it.
you would use it like:
public class Test  {
    public static void display( java.util.regex.Matcher m ) {
     if( !m.find() ) {
         System.out.println( "No Matches" );
         return;
     System.out.println( "Match:" );
     // We know if it matches the first group will be everything, and the
     // second will be the capturing group.
     System.out.println( m.group( 1 ) );
    public static void main(java.lang.String[] args) {
     String regex = "^\\s*\\*\\s{1,}TODO\\s{1,}(.{1,})$";
     String notAtodo = "int hello = 1;";
     String aTodo = "\t* TODO use a loop FileReader & readLine()";
     java.util.regex.Pattern p = java.util.regex.Pattern.compile( regex );
     System.out.println( notAtodo );
     display( p.matcher( notAtodo )  );
     System.out.println( aTodo );
     display( p.matcher( aTodo )  );     
}You might notice that it does not check to see if the commennts have been started, well if they have not the compiler will fail, so doc'ing it will be pointless :)