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

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

Revision: 200
          http://svn.sourceforge.net/japi/?rev=200&view=rev
Author:   christianhujer
Date:     2006-11-21 12:02:17 -0800 (Tue, 21 Nov 2006)

Log Message:
-----------
Improved comment, generified code.

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

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java	2006-11-21 19:38:01 UTC (rev 199)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java	2006-11-21 20:02:17 UTC (rev 200)
@@ -5,8 +5,11 @@
 import java.util.Map;
 
 /**
- * Taglet for fixme block tags.
+ * Taglet for entries in a fixme list.
+ * A fixme entry denotes code that is known to be bogus and needs fixing.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @see TodoTaglet for general work that needs to be done
+ * @see XxxTaglet for code that looks bogus but seems to work
  */
 public class FixmeTaglet extends BlockListTaglet {
 
@@ -21,7 +24,7 @@
      * Register this Taglet.
      * @param tagletMap the map to register this tag to.
      */
-    public static void register(final Map tagletMap) {
+    public static void register(final Map<String, Taglet> tagletMap) {
         final Taglet taglet = new FixmeTaglet();
         tagletMap.put(taglet.getName(), taglet);
     }

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java	2006-11-21 19:38:01 UTC (rev 199)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java	2006-11-21 20:02:17 UTC (rev 200)
@@ -5,8 +5,13 @@
 import java.util.Map;
 
 /**
- * Taglet for todo block tags.
+ * Taglet for entries in a todo list.
+ * 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}.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @see XxxTaglet for code that looks bogus but seems to work
+ * @see FixmeTaglet for code that is known to be bogus
  */
 public class TodoTaglet extends BlockListTaglet {
 
@@ -21,7 +26,7 @@
      * Register this Taglet.
      * @param tagletMap the map to register this tag to.
      */
-    public static void register(final Map tagletMap) {
+    public static void register(final Map<String, Taglet> tagletMap) {
         final Taglet taglet = new TodoTaglet();
         tagletMap.put(taglet.getName(), taglet);
     }

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java	2006-11-21 19:38:01 UTC (rev 199)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java	2006-11-21 20:02:17 UTC (rev 200)
@@ -5,8 +5,11 @@
 import java.util.Map;
 
 /**
- * Taglet for xxx block tags.
+ * Taglet for entries in an xxx list.
+ * An xxx entry denotes code that seems to work and looks bogus or might be a Schroedinbug.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @see TodoTaglet for general work that needs to be done
+ * @see FixmeTaglet for code that is known to be bogus
  */
 public class XxxTaglet extends BlockListTaglet {
 
@@ -21,7 +24,7 @@
      * Register this Taglet.
      * @param tagletMap the map to register this tag to.
      */
-    public static void register(final Map tagletMap) {
+    public static void register(final Map<String, Taglet> tagletMap) {
         final Taglet taglet = new XxxTaglet();
         tagletMap.put(taglet.getName(), taglet);
     }


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