Thread: [Japi-cvs] SF.net SVN: japi: [198] libs/taglets/trunk/src/net/sf/japi/taglets
Status: Beta
Brought to you by:
christianhujer
Menu
▾
▴
japi-cvs
|
From: <chr...@us...> - 2006-11-20 21:48:47
|
Revision: 198
http://svn.sourceforge.net/japi/?rev=198&view=rev
Author: christianhujer
Date: 2006-11-20 13:48:45 -0800 (Mon, 20 Nov 2006)
Log Message:
-----------
Fixed some documentation bugs.
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-20 21:10:28 UTC (rev 197)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java 2006-11-20 21:48:45 UTC (rev 198)
@@ -5,6 +5,8 @@
import java.util.Map;
/**
+ * Taglet for fixme block tags.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
public class FixmeTaglet extends BlockListTaglet {
@@ -24,4 +26,4 @@
tagletMap.put(taglet.getName(), taglet);
}
-} // class XxxTaglet
+} // class FixmeTaglet
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2006-11-20 21:10:28 UTC (rev 197)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2006-11-20 21:48:45 UTC (rev 198)
@@ -5,6 +5,8 @@
import java.util.Map;
/**
+ * Taglet for todo block tags.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
public class TodoTaglet extends BlockListTaglet {
@@ -24,4 +26,4 @@
tagletMap.put(taglet.getName(), taglet);
}
-} // class XxxTaglet
+} // class TodoTaglet
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java 2006-11-20 21:10:28 UTC (rev 197)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java 2006-11-20 21:48:45 UTC (rev 198)
@@ -5,6 +5,8 @@
import java.util.Map;
/**
+ * Taglet for xxx block tags.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
public class XxxTaglet extends BlockListTaglet {
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2006-11-21 20:02:20
|
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.
|
|
From: <chr...@us...> - 2006-11-21 21:25:00
|
Revision: 201
http://svn.sourceforge.net/japi/?rev=201&view=rev
Author: christianhujer
Date: 2006-11-21 13:24:59 -0800 (Tue, 21 Nov 2006)
Log Message:
-----------
Fixed docu bugs.
Modified Paths:
--------------
libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.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 20:02:17 UTC (rev 200)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java 2006-11-21 21:24:59 UTC (rev 201)
@@ -14,7 +14,7 @@
public class FixmeTaglet extends BlockListTaglet {
/**
- * Create an XxxTaglet.
+ * Create an FixmeTaglet.
*/
protected FixmeTaglet() {
super("fixme", "Fixme");
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2006-11-21 20:02:17 UTC (rev 200)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2006-11-21 21:24:59 UTC (rev 201)
@@ -16,7 +16,7 @@
public class TodoTaglet extends BlockListTaglet {
/**
- * Create an XxxTaglet.
+ * Create an TodoTaglet.
*/
protected TodoTaglet() {
super("todo", "Todo");
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2006-11-21 21:26:26
|
Revision: 202
http://svn.sourceforge.net/japi/?rev=202&view=rev
Author: christianhujer
Date: 2006-11-21 13:25:58 -0800 (Tue, 21 Nov 2006)
Log Message:
-----------
Added warning and note taglets.
Added Paths:
-----------
libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
Added: libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2006-11-21 21:25:58 UTC (rev 202)
@@ -0,0 +1,31 @@
+package net.sf.japi.taglets;
+
+import com.sun.tools.doclets.Taglet;
+
+import java.util.Map;
+
+/**
+ * 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>
+ * @see NoteTaglet for less severe notes
+ */
+public class NoteTaglet extends BlockListTaglet {
+
+ /**
+ * Create a WarningTaglet.
+ */
+ protected NoteTaglet() {
+ super("note", "Notes");
+ }
+
+ /**
+ * 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 NoteTaglet();
+ tagletMap.put(taglet.getName(), taglet);
+ }
+
+} // class WarningTaglet
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ LF
Added: libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2006-11-21 21:25:58 UTC (rev 202)
@@ -0,0 +1,31 @@
+package net.sf.japi.taglets;
+
+import com.sun.tools.doclets.Taglet;
+
+import java.util.Map;
+
+/**
+ * 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>
+ * @see NoteTaglet for less severe notes
+ */
+public class WarningTaglet extends BlockListTaglet {
+
+ /**
+ * Create a WarningTaglet.
+ */
+ protected WarningTaglet() {
+ super("warning", "Warnings");
+ }
+
+ /**
+ * 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 WarningTaglet();
+ tagletMap.put(taglet.getName(), taglet);
+ }
+
+} // class WarningTaglet
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.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.
|
|
From: <chr...@us...> - 2006-11-21 22:15:24
|
Revision: 203
http://svn.sourceforge.net/japi/?rev=203&view=rev
Author: christianhujer
Date: 2006-11-21 14:15:18 -0800 (Tue, 21 Nov 2006)
Log Message:
-----------
Made constructors private. Added taglets for invariant, precondition and postcondition.
Modified Paths:
--------------
libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java
Added Paths:
-----------
libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.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 21:25:58 UTC (rev 202)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -16,7 +16,7 @@
/**
* Create an FixmeTaglet.
*/
- protected FixmeTaglet() {
+ private FixmeTaglet() {
super("fixme", "Fixme");
}
Added: libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -0,0 +1,31 @@
+package net.sf.japi.taglets;
+
+import com.sun.tools.doclets.Taglet;
+
+import java.util.Map;
+
+/**
+ * Taglet for documenting invariants.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @see PreconditionTaglet
+ * @see PostconditionTaglet
+ */
+public class InvariantTaglet extends BlockListTaglet {
+
+ /**
+ * Create a InvariantTaglet.
+ */
+ private InvariantTaglet() {
+ super("invariant", "Invariants");
+ }
+
+ /**
+ * 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 InvariantTaglet();
+ tagletMap.put(taglet.getName(), taglet);
+ }
+
+} // class WarningTaglet
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ LF
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2006-11-21 21:25:58 UTC (rev 202)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -15,7 +15,7 @@
/**
* Create a WarningTaglet.
*/
- protected NoteTaglet() {
+ private NoteTaglet() {
super("note", "Notes");
}
Added: libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -0,0 +1,31 @@
+package net.sf.japi.taglets;
+
+import com.sun.tools.doclets.Taglet;
+
+import java.util.Map;
+
+/**
+ * Taglet for documenting postconditions.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @see InvariantTaglet
+ * @see PreconditionTaglet
+ */
+public class PostconditionTaglet extends BlockListTaglet {
+
+ /**
+ * Create a PostconditionTaglet.
+ */
+ private PostconditionTaglet() {
+ super("postcondition", "Postconditions");
+ }
+
+ /**
+ * 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 PostconditionTaglet();
+ tagletMap.put(taglet.getName(), taglet);
+ }
+
+} // class WarningTaglet
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ LF
Added: libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -0,0 +1,31 @@
+package net.sf.japi.taglets;
+
+import com.sun.tools.doclets.Taglet;
+
+import java.util.Map;
+
+/**
+ * Taglet for documenting preconditions.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ * @see PostconditionTaglet
+ * @see InvariantTaglet
+ */
+public class PreconditionTaglet extends BlockListTaglet {
+
+ /**
+ * Create a PreconditionTaglet.
+ */
+ private PreconditionTaglet() {
+ super("precondition", "Preconditions");
+ }
+
+ /**
+ * 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 PreconditionTaglet();
+ tagletMap.put(taglet.getName(), taglet);
+ }
+
+} // class WarningTaglet
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ LF
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2006-11-21 21:25:58 UTC (rev 202)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -18,7 +18,7 @@
/**
* Create an TodoTaglet.
*/
- protected TodoTaglet() {
+ private TodoTaglet() {
super("todo", "Todo");
}
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2006-11-21 21:25:58 UTC (rev 202)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -15,7 +15,7 @@
/**
* Create a WarningTaglet.
*/
- protected WarningTaglet() {
+ private WarningTaglet() {
super("warning", "Warnings");
}
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java 2006-11-21 21:25:58 UTC (rev 202)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java 2006-11-21 22:15:18 UTC (rev 203)
@@ -16,7 +16,7 @@
/**
* Create an XxxTaglet.
*/
- protected XxxTaglet() {
+ private XxxTaglet() {
super("xxx", "XXX");
}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2006-11-25 10:15:31
|
Revision: 205
http://svn.sourceforge.net/japi/?rev=205&view=rev
Author: christianhujer
Date: 2006-11-25 02:15:28 -0800 (Sat, 25 Nov 2006)
Log Message:
-----------
Changed postcondition and precondition to be applicable to code only.
Modified Paths:
--------------
libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2006-11-21 22:23:03 UTC (rev 204)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2006-11-25 10:15:28 UTC (rev 205)
@@ -19,6 +19,26 @@
super("postcondition", "Postconditions");
}
+ /** {@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.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2006-11-21 22:23:03 UTC (rev 204)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2006-11-25 10:15:28 UTC (rev 205)
@@ -19,6 +19,26 @@
super("precondition", "Preconditions");
}
+ /** {@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.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2006-12-03 14:10:28
|
Revision: 248
http://svn.sourceforge.net/japi/?rev=248&view=rev
Author: christianhujer
Date: 2006-12-03 06:10:26 -0800 (Sun, 03 Dec 2006)
Log Message:
-----------
Added support for singular / plural titles.
Modified Paths:
--------------
libs/taglets/trunk/src/net/sf/japi/taglets/BlockListTaglet.java
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
libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/BlockListTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/BlockListTaglet.java 2006-12-03 14:05:18 UTC (rev 247)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/BlockListTaglet.java 2006-12-03 14:10:26 UTC (rev 248)
@@ -2,31 +2,47 @@
import com.sun.javadoc.Tag;
import com.sun.tools.doclets.Taglet;
+import org.jetbrains.annotations.NotNull;
/**
* Base class for Taglets that are simple blocks transforming into lists.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @todo add user definable background colour
- * @todo auto-detect singular / plural of heading
*/
public abstract class BlockListTaglet implements Taglet {
/** The name of this Taglet. */
private final String name;
- /** The title of this Taglet. */
- private final String title;
+ /** The singular title of this Taglet. */
+ private final String singularTitle;
+ /** The plural title of this Taglet. */
+ private final String pluralTitle;
+
/**
* Create a BLockListTaglet.
* @param name Name of this Taglet (e.g. "todo").
- * @param title Title of this Taglet (e.g. "Todo").
+ * @param title Title of this Taglet (e.g. "Todo") for both, singular and plural.
*/
- protected BlockListTaglet(final String name, final String title) {
+ protected BlockListTaglet(@NotNull final String name, @NotNull final String title) {
this.name = name;
- this.title = title;
+ this.singularTitle = title;
+ this.pluralTitle = title;
}
+ /**
+ * Create a BLockListTaglet.
+ * @param name Name of this Taglet (e.g. "note").
+ * @param singularTitle Singular title of this taglet (e.g. "note").
+ * @param pluralTitle Plural title of this taglet (e.g. "notes").
+ */
+ protected BlockListTaglet(@NotNull final String name, @NotNull final String singularTitle, @NotNull final String pluralTitle) {
+ this.name = name;
+ this.singularTitle = singularTitle;
+ this.pluralTitle = pluralTitle;
+ }
+
/** {@inheritDoc} */
public String getName() {
return name;
@@ -71,7 +87,7 @@
public String toString(final Tag tag) {
final StringBuilder sb = new StringBuilder();
sb.append("<DL><DT><B>");
- sb.append(title);
+ sb.append(singularTitle);
sb.append("</B></DT><DD><UL><LI>");
sb.append(tag.text());
sb.append("</LI></UL></DD></DL>");
@@ -88,7 +104,7 @@
}
final StringBuilder sb = new StringBuilder();
sb.append("<DL><DT><B>");
- sb.append(title);
+ sb.append(pluralTitle);
sb.append("</B></DT><DD><UL>");
for (final Tag tag : tags) {
sb.append("<LI>");
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java 2006-12-03 14:05:18 UTC (rev 247)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java 2006-12-03 14:10:26 UTC (rev 248)
@@ -16,7 +16,7 @@
* Create a InvariantTaglet.
*/
private InvariantTaglet() {
- super("invariant", "Invariants");
+ super("invariant", "Invariant", "Invariants");
}
/**
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2006-12-03 14:05:18 UTC (rev 247)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2006-12-03 14:10:26 UTC (rev 248)
@@ -5,7 +5,7 @@
import java.util.Map;
/**
- * Taglet for entries in a warnings list.
+ * 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>
* @see NoteTaglet for less severe notes
@@ -13,10 +13,10 @@
public class NoteTaglet extends BlockListTaglet {
/**
- * Create a WarningTaglet.
+ * Create a NoteTaglet.
*/
private NoteTaglet() {
- super("note", "Notes");
+ super("note", "Note", "Notes");
}
/**
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2006-12-03 14:05:18 UTC (rev 247)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2006-12-03 14:10:26 UTC (rev 248)
@@ -16,7 +16,7 @@
* Create a PostconditionTaglet.
*/
private PostconditionTaglet() {
- super("postcondition", "Postconditions");
+ super("postcondition", "Postcondition", "Postconditions");
}
/** {@inheritDoc} */
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2006-12-03 14:05:18 UTC (rev 247)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2006-12-03 14:10:26 UTC (rev 248)
@@ -16,7 +16,7 @@
* Create a PreconditionTaglet.
*/
private PreconditionTaglet() {
- super("precondition", "Preconditions");
+ super("precondition", "Precondition", "Preconditions");
}
/** {@inheritDoc} */
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2006-12-03 14:05:18 UTC (rev 247)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2006-12-03 14:10:26 UTC (rev 248)
@@ -16,7 +16,7 @@
* Create a WarningTaglet.
*/
private WarningTaglet() {
- super("warning", "Warnings");
+ super("warning", "Warning", "Warnings");
}
/**
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2007-02-03 22:34:41
|
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.
|
|
From: <chr...@us...> - 2007-06-25 15:10:27
|
Revision: 438
http://svn.sourceforge.net/japi/?rev=438&view=rev
Author: christianhujer
Date: 2007-06-25 08:10:25 -0700 (Mon, 25 Jun 2007)
Log Message:
-----------
Made classes with private constructors final. Checkstyle now doesn't complain about taglets.
Modified Paths:
--------------
libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java
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
libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.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 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/FixmeTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -30,7 +30,7 @@
* @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 {
+public final class FixmeTaglet extends BlockListTaglet {
/**
* Create an FixmeTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/InvariantTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -29,7 +29,7 @@
* @see PreconditionTaglet
* @see PostconditionTaglet
*/
-public class InvariantTaglet extends BlockListTaglet {
+public final class InvariantTaglet extends BlockListTaglet {
/**
* Create a InvariantTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/NoteTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -29,7 +29,7 @@
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @see NoteTaglet for less severe notes
*/
-public class NoteTaglet extends BlockListTaglet {
+public final class NoteTaglet extends BlockListTaglet {
/**
* Create a NoteTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PostconditionTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -29,7 +29,7 @@
* @see InvariantTaglet
* @see PreconditionTaglet
*/
-public class PostconditionTaglet extends BlockListTaglet {
+public final class PostconditionTaglet extends BlockListTaglet {
/**
* Create a PostconditionTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/PreconditionTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -29,7 +29,7 @@
* @see PostconditionTaglet
* @see InvariantTaglet
*/
-public class PreconditionTaglet extends BlockListTaglet {
+public final class PreconditionTaglet extends BlockListTaglet {
/**
* Create a PreconditionTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/ReturnValueTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -26,7 +26,7 @@
* Taglet for documenting return values.
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
*/
-public class ReturnValueTaglet extends BlockListTaglet {
+public final class ReturnValueTaglet extends BlockListTaglet {
/**
* Create a ReturnValueTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/TodoTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -32,7 +32,7 @@
* @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 {
+public final class TodoTaglet extends BlockListTaglet {
/**
* Create an TodoTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/WarningTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -29,7 +29,7 @@
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @see NoteTaglet for less severe notes
*/
-public class WarningTaglet extends BlockListTaglet {
+public final class WarningTaglet extends BlockListTaglet {
/**
* Create a WarningTaglet.
Modified: libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java 2007-06-25 14:10:30 UTC (rev 437)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/XxxTaglet.java 2007-06-25 15:10:25 UTC (rev 438)
@@ -30,7 +30,7 @@
* @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 {
+public final class XxxTaglet extends BlockListTaglet {
/**
* Create an XxxTaglet.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2007-08-20 22:58:29
|
Revision: 586
http://japi.svn.sourceforge.net/japi/?rev=586&view=rev
Author: christianhujer
Date: 2007-08-20 15:58:27 -0700 (Mon, 20 Aug 2007)
Log Message:
-----------
[ 1777777 ] @history taglet
Added Paths:
-----------
libs/taglets/trunk/src/net/sf/japi/taglets/HistoryTaglet.java
libs/taglets/trunk/src/net/sf/japi/taglets/TagByTextComparator.java
Added: libs/taglets/trunk/src/net/sf/japi/taglets/HistoryTaglet.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/HistoryTaglet.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/HistoryTaglet.java 2007-08-20 22:58:27 UTC (rev 586)
@@ -0,0 +1,157 @@
+/*
+ * 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.javadoc.Tag;
+import com.sun.tools.doclets.Taglet;
+import java.text.DateFormat;
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.Arrays;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Taglet for history.
+ * Format: history date developer Comment.
+ * Separate developers and Comment with two whitespace.
+ * 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>
+ */
+public class HistoryTaglet implements Taglet {
+
+ /** The pattern to use for checking. */
+ private static final Pattern PATTERN = Pattern.compile("^(\\d\\d\\d\\d-\\d\\d-\\d\\d) (.*?) (.*?)$");
+
+ /** The DateFormat for ISO dates. */
+ private static final DateFormat ISO_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd");
+
+ /** {@inheritDoc} */
+ public boolean inField() {
+ return true;
+ }
+
+ /** {@inheritDoc} */
+ public boolean inConstructor() {
+ return true;
+ }
+
+ /** {@inheritDoc} */
+ public boolean inMethod() {
+ return true;
+ }
+
+ /** {@inheritDoc} */
+ public boolean inOverview() {
+ return true;
+ }
+
+ /** {@inheritDoc} */
+ public boolean inPackage() {
+ return true;
+ }
+
+ /** {@inheritDoc} */
+ public boolean inType() {
+ return true;
+ }
+
+ /** {@inheritDoc} */
+ public boolean isInlineTag() {
+ return false;
+ }
+
+ /** {@inheritDoc} */
+ public String getName() {
+ return "history";
+ }
+
+ /** {@inheritDoc} */
+ public String toString(final Tag tag) {
+ final StringBuilder sb = new StringBuilder();
+ sb.append("<DL><DT><B>");
+ sb.append("History:");
+ sb.append("</B></DT><DD><TABLE><TR><TH>Date</TH><TH>Developer(s)</TH><TH>Changes</TH></TR>");
+ append(sb, tag);
+ sb.append("</TABLE></DD></DL>");
+ return sb.toString();
+ }
+
+ /** {@inheritDoc} */
+ public String toString(final Tag[] tags) {
+ if (tags == null || tags.length == 0) {
+ return null;
+ }
+ if (tags.length == 1) {
+ return toString(tags[0]);
+ }
+ final StringBuilder sb = new StringBuilder();
+ sb.append("<DL><DT><B>");
+ sb.append("History:");
+ sb.append("</B></DT><DD><TABLE><TR><TH>Date</TH><TH>Developer(s)</TH><TH>Changes</TH></TR>");
+ final Tag[] myTags = tags.clone();
+ Arrays.sort(myTags, TagByTextComparator.INSTANCE);
+ for (final Tag tag : tags) {
+ append(sb, tag);
+ }
+ sb.append("</TABLE></DD></DL>");
+ return sb.toString();
+ }
+
+ /** Appends a tag to the text as a table.
+ * @param sb StringBuilder to append to.
+ * @param tag Tag to append
+ */
+ private void append(final StringBuilder sb, final Tag tag) {
+ final String text = tag.text();
+ final Matcher matcher = PATTERN.matcher(text);
+ if (!matcher.matches()) {
+ System.err.println(tag.position() + ": warning - @" + getName() + " not formatted correctly.");
+ return;
+ }
+ final String dateText = matcher.group(1);
+ final String developers = matcher.group(2);
+ final String comment = matcher.group(3);
+ try {
+ ISO_DATE_FORMAT.parse(dateText);
+ } catch (final ParseException e) {
+ System.err.println(tag.position() + ": warning - @" + getName() + " has a date in wrong format (not-iso).");
+ }
+ sb.append("<TR><TD>");
+ sb.append(dateText);
+ sb.append("</TD><TD>");
+ sb.append(developers);
+ sb.append("</TD><TD>");
+ sb.append(comment);
+ sb.append("</TD></TR>");
+ }
+
+ /**
+ * 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 HistoryTaglet();
+ tagletMap.put(taglet.getName(), taglet);
+ }
+
+} // class HistoryTaglet
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/HistoryTaglet.java
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ LF
Added: libs/taglets/trunk/src/net/sf/japi/taglets/TagByTextComparator.java
===================================================================
--- libs/taglets/trunk/src/net/sf/japi/taglets/TagByTextComparator.java (rev 0)
+++ libs/taglets/trunk/src/net/sf/japi/taglets/TagByTextComparator.java 2007-08-20 22:58:27 UTC (rev 586)
@@ -0,0 +1,39 @@
+/*
+ * 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.javadoc.Tag;
+import java.util.Comparator;
+
+/**
+ * Compares Javadoc Tags by their text.
+ * @author <a href="mailto:ch...@ri...">Christian Hujer</a>
+ */
+public class TagByTextComparator implements Comparator<Tag> {
+
+ /** Static instance. */
+ public static Comparator<Tag> INSTANCE = new TagByTextComparator();
+
+ /** {@inheritDoc} */
+ public int compare(final Tag o1, final Tag o2) {
+ return o1.text().compareTo(o2.text());
+ }
+
+} // class TagByTextComparator
Property changes on: libs/taglets/trunk/src/net/sf/japi/taglets/TagByTextComparator.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.
|
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X