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

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

Revision: 1237
          http://japi.svn.sourceforge.net/japi/?rev=1237&view=rev
Author:   christianhujer
Date:     2009-03-02 01:26:01 +0000 (Mon, 02 Mar 2009)

Log Message:
-----------
 Add @since information for classes and packages.

Modified Paths:
--------------
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/InvariantTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/NoteTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/TagByTextComparator.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/WarningTaglet.java
    libs/taglets/trunk/src/prj/net/sf/japi/taglets/XxxTaglet.java

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -26,6 +26,7 @@
 /**
  * Base class for Taglets that are simple blocks transforming into lists.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  * @todo add user definable background colour
  */
 public abstract class BlockListTaglet implements Taglet {

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/FixmeTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -25,6 +25,7 @@
  * 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>
+ * @since 0.1
  * @see TodoTaglet for general work that needs to be done
  * @see XxxTaglet for code that looks bogus but seems to work
  */

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -35,6 +35,7 @@
  * Date must be ISO.
  * You shouldn't use it for something your version control system can handle anyway but in a much more reliable way.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class HistoryTaglet implements Taglet {
 

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/InvariantTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/InvariantTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/InvariantTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -24,6 +24,7 @@
 /**
  * Taglet for documenting invariants.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  * @see PreconditionTaglet
  * @see PostconditionTaglet
  */

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/NoteTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/NoteTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/NoteTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -25,6 +25,7 @@
  * Taglet for entries in a notes list.
  * A warning states that somebody must take care of something when using the symbol documented with the warning.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  * @see NoteTaglet for less severe notes
  */
 public final class NoteTaglet extends BlockListTaglet {

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -24,6 +24,7 @@
 /**
  * Taglet for documenting postconditions.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  * @see InvariantTaglet
  * @see PreconditionTaglet
  */

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -24,6 +24,7 @@
 /**
  * Taglet for documenting preconditions.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  * @see PostconditionTaglet
  * @see InvariantTaglet
  */

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -24,6 +24,7 @@
 /**
  * Taglet for documenting return values.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public final class ReturnValueTaglet extends BlockListTaglet {
 

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/TagByTextComparator.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/TagByTextComparator.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/TagByTextComparator.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -26,6 +26,7 @@
  * Compares Javadoc Tags by their text.
  * Note: this comparator imposes orderings that are inconsistent with equals.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  */
 public class TagByTextComparator implements Comparator<Tag>, Serializable {
 

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/TodoTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -27,6 +27,7 @@
  * 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>
+ * @since 0.1
  * @see XxxTaglet for code that looks bogus but seems to work
  * @see FixmeTaglet for code that is known to be bogus
  */

Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/WarningTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/WarningTaglet.java	2009-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/WarningTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -25,6 +25,7 @@
  * Taglet for entries in a warnings list.
  * A warning states that somebody must take care of something when using the symbol documented with the warning.
  * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @since 0.1
  * @see NoteTaglet for less severe notes
  */
 public final class WarningTaglet 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-03-02 01:25:28 UTC (rev 1236)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/XxxTaglet.java	2009-03-02 01:26:01 UTC (rev 1237)
@@ -25,6 +25,7 @@
  * 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>
+ * @since 0.1
  * @see TodoTaglet for general work that needs to be done
  * @see FixmeTaglet for code that is known to be bogus
  */


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