Package org.tquadrat.foundation.javadoc

Class ToDoTaglet

java.lang.Object
org.tquadrat.foundation.javadoc.ToDoTaglet
All Implemented Interfaces:
Taglet
@ClassVersion(sourceVersion="$Id: ToDoTaglet.java 978 2022-01-06 12:47:52Z tquadrat $") @API(status=STABLE, since="0.0.5") public final class ToDoTaglet extends Object implements Taglet

With this taglet, it is possible to add a list of open points to the documentation of a module or a package. The parameter of the tag is the (absolute) path to a text file in Markdown format; this path will be combined with the path provided by the system property "org.tquadrat.foundation.todo.base" (if any).

In the file, each open point consists of a sequence of lines that will end with an empty line (a paragraph in Markdown). HTML tags are taken as they are, JavaDoc tags will be not interpreted.

So the module-info.java file for a project may look like this:

 /**
  * …
  *
  * @todo /task.list
  */
  module my.module
  {
      requires java.base;
      requires …

      exports …
  }

With "org.tquadrat.foundation.todo.base" set to "/home/programmer/project/", the file will be searched at "/home/programmer/project/task.list".

Given the contents of that file looks like this:

  Cleanup the class comments

  Re-think the parser implementation

the generated Module description will look like this:

Sample JavaDoc output

Module my.module

…
Open Issues (The ToDo List):

Cleanup the class comments

Re-think the parser implementation

…

With Maven or Gradle, the base path can be easily set to the project root.

The file is interpreted as Markdown since version 0.2.0, before it was a plain text file.

Author:
Thomas Thrien - thomas.thrien@tquadrat.org
Version:
$Id: ToDoTaglet.java 978 2022-01-06 12:47:52Z tquadrat $
Since:
0.0.5