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

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

Revision: 326
          http://svn.sourceforge.net/japi/?rev=326&view=rev
Author:   christianhujer
Date:     2007-02-03 14:34:38 -0800 (Sat, 03 Feb 2007)

Log Message:
-----------
Fixed some documentation.
Added taglet for documenting return values.

Modified Paths:
--------------
    libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
    libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
    libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
    libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java

Added Paths:
-----------
    libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java	2007-01-30 22:19:50 UTC (rev 325)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java	2007-02-03 22:34:38 UTC (rev 326)
@@ -47,4 +47,4 @@
         tagletMap.put(taglet.getName(), taglet);
     }
 
-} // class WarningTaglet
+} // class InvariantTaglet

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java	2007-01-30 22:19:50 UTC (rev 325)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java	2007-02-03 22:34:38 UTC (rev 326)
@@ -47,4 +47,4 @@
         tagletMap.put(taglet.getName(), taglet);
     }
 
-} // class WarningTaglet
+} // class NoteTaglet

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java	2007-01-30 22:19:50 UTC (rev 325)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java	2007-02-03 22:34:38 UTC (rev 326)
@@ -67,4 +67,4 @@
         tagletMap.put(taglet.getName(), taglet);
     }
 
-} // class WarningTaglet
+} // class PostConditionTaglet

Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java	2007-01-30 22:19:50 UTC (rev 325)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java	2007-02-03 22:34:38 UTC (rev 326)
@@ -67,4 +67,4 @@
         tagletMap.put(taglet.getName(), taglet);
     }
 
-} // class WarningTaglet
+} // class PreconditionTaglet

Added: libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java	                        (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java	2007-02-03 22:34:38 UTC (rev 326)
@@ -0,0 +1,67 @@
+/*
+ * JAPI libs-taglets is a library that has some useful additional taglets for javadoc.
+ * Copyright (C) 2007  Christian Hujer.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package net.sf.japi.taglets;
+
+import com.sun.tools.doclets.Taglet;
+import java.util.Map;
+
+/**
+ * Taglet for documenting return values.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ */
+public class ReturnValueTaglet extends BlockListTaglet {
+
+    /**
+     * Create a ReturnValueTaglet.
+     */
+    private ReturnValueTaglet() {
+        super("retval", "Return Value", "Return Values");
+    }
+
+    /** {@inheritDoc} */
+    @Override public boolean inField() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override public boolean inOverview() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override public boolean inPackage() {
+        return false;
+    }
+
+    /** {@inheritDoc} */
+    @Override public boolean inType() {
+        return false;
+    }
+
+    /**
+     * Register this Taglet.
+     * @param tagletMap the map to register this tag to.
+     */
+    public static void register(final Map<String, Taglet> tagletMap) {
+        final Taglet taglet = new ReturnValueTaglet();
+        tagletMap.put(taglet.getName(), taglet);
+    }
+
+} // class ReturnValueTaglet


Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF


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