[Japi-cvs] SF.net SVN: japi:[1362] libs/taglets/trunk/src/prj/net/sf/japi/taglets

[<chr...@us...>]

Revision: 1362
          http://japi.svn.sourceforge.net/japi/?rev=1362&view=rev
Author:   christianhujer
Date:     2009-07-25 12:55:32 +0000 (Sat, 25 Jul 2009)

Log Message:
-----------
Add reference to TODO syntax specification.

Modified Paths:
--------------
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/XxxTaglet.java

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java	2009-07-25 12:40:30 UTC (rev 1361)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java	2009-07-25 12:55:32 UTC (rev 1362)
@@ -24,10 +24,15 @@
 /**
  * Taglet for entries in a fixme list.
  * A fixme entry denotes code that is known to be bogus and needs fixing.
+ *
+ * @note This tag should only be used if the issue in context is important for the reader of the documentation.
+ *       Internal issues should not be put in javadoc.
+ *
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  * @since 0.1
  * @see TodoTaglet for general work that needs to be done
  * @see XxxTaglet for code that looks bogus but seems to work
+ * @see <a href="http://www.riedquat.de/TR/TODO_Syntax">TODO Syntax Specification</a>
  */
 public final class FixmeTaglet extends BlockListTaglet {
 

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java	2009-07-25 12:40:30 UTC (rev 1361)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java	2009-07-25 12:55:32 UTC (rev 1362)
@@ -26,10 +26,15 @@
  * A todo entry states a missing or unimplemented feature or other work that needs to be done as soon as sombody has time for it.
  * Todo entries shouldn't be used for code that is known to be or at least looks like being erraneous.
  * For these situations, use either {@link XxxTaglet @xxx} or {@link FixmeTaglet @fixme}.
+ *
+ * @note This tag should only be used if the issue in context is important for the reader of the documentation.
+ *       Internal issues should not be put in javadoc.
+ *
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  * @since 0.1
  * @see XxxTaglet for code that looks bogus but seems to work
  * @see FixmeTaglet for code that is known to be bogus
+ * @see <a href="http://www.riedquat.de/TR/TODO_Syntax">TODO Syntax Specification</a>
  */
 public final class TodoTaglet extends BlockListTaglet {
 

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/XxxTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/XxxTaglet.java	2009-07-25 12:40:30 UTC (rev 1361)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/XxxTaglet.java	2009-07-25 12:55:32 UTC (rev 1362)
@@ -24,10 +24,15 @@
 /**
  * Taglet for entries in an xxx list.
  * An xxx entry denotes code that seems to work and looks bogus or might be a Schroedinbug.
+ *
+ * @note This tag should only be used if the issue in context is important for the reader of the documentation.
+ *       Internal issues should not be put in javadoc.
+ *
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
  * @since 0.1
  * @see TodoTaglet for general work that needs to be done
  * @see FixmeTaglet for code that is known to be bogus
+ * @see <a href="http://www.riedquat.de/TR/TODO_Syntax">TODO Syntax Specification</a>
  */
 public final class XxxTaglet extends BlockListTaglet {
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.