Thread: [Japi-cvs] SF.net SVN: japi:[1237] libs/taglets/trunk/src/prj/net/sf/japi/taglets
Status: Beta
Brought to you by:
christianhujer
Menu
▾
▴
japi-cvs
|
From: <chr...@us...> - 2009-03-02 01:26:04
|
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.
|
|
From: <chr...@us...> - 2009-07-25 12:38:20
|
Revision: 1357
http://japi.svn.sourceforge.net/japi/?rev=1357&view=rev
Author: christianhujer
Date: 2009-07-25 12:38:13 +0000 (Sat, 25 Jul 2009)
Log Message:
-----------
Fix warnings.
Modified Paths:
--------------
libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java
libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.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
Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java 2009-07-25 12:36:49 UTC (rev 1356)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java 2009-07-25 12:38:13 UTC (rev 1357)
@@ -29,6 +29,7 @@
* @since 0.1
* @todo add user definable background colour
*/
+@SuppressWarnings({"AbstractClassWithoutAbstractMethods"})
public abstract class BlockListTaglet implements Taglet {
/** The name of this Taglet. */
Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java 2009-07-25 12:36:49 UTC (rev 1356)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java 2009-07-25 12:38:13 UTC (rev 1357)
@@ -27,6 +27,7 @@
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+import org.jetbrains.annotations.Nullable;
/**
* Taglet for history.
@@ -97,6 +98,7 @@
}
/** {@inheritDoc} */
+ @Nullable
public String toString(final Tag[] tags) {
if (tags == null || tags.length == 0) {
return null;
Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java 2009-07-25 12:36:49 UTC (rev 1356)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/PostconditionTaglet.java 2009-07-25 12:38:13 UTC (rev 1357)
@@ -28,6 +28,7 @@
* @see InvariantTaglet
* @see PreconditionTaglet
*/
+@SuppressWarnings({"RefusedBequest"})
public final class PostconditionTaglet extends BlockListTaglet {
/**
Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java 2009-07-25 12:36:49 UTC (rev 1356)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/PreconditionTaglet.java 2009-07-25 12:38:13 UTC (rev 1357)
@@ -28,6 +28,7 @@
* @see PostconditionTaglet
* @see InvariantTaglet
*/
+@SuppressWarnings({"RefusedBequest"})
public final class PreconditionTaglet extends BlockListTaglet {
/**
Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java 2009-07-25 12:36:49 UTC (rev 1356)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/ReturnValueTaglet.java 2009-07-25 12:38:13 UTC (rev 1357)
@@ -26,6 +26,7 @@
* @author <a href="mailto:ch...@ri...">Christian Hujer</a>
* @since 0.1
*/
+@SuppressWarnings({"RefusedBequest"})
public final class ReturnValueTaglet extends BlockListTaglet {
/**
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <chr...@us...> - 2009-07-25 12:55:39
|
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.
|
|
From: <chr...@us...> - 2009-07-25 12:55:56
|
Revision: 1363
http://japi.svn.sourceforge.net/japi/?rev=1363&view=rev
Author: christianhujer
Date: 2009-07-25 12:55:50 +0000 (Sat, 25 Jul 2009)
Log Message:
-----------
Fix bug with double nested lists.
Modified Paths:
--------------
libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java
libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.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-07-25 12:55:32 UTC (rev 1362)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/BlockListTaglet.java 2009-07-25 12:55:50 UTC (rev 1363)
@@ -107,11 +107,11 @@
/** {@inheritDoc} */
public String toString(final Tag tag) {
final StringBuilder sb = new StringBuilder();
- sb.append("<DL><DT><B>");
+ sb.append("<DT><B>");
sb.append(singularTitle);
sb.append("</B></DT><DD><UL><LI>");
sb.append(tag.text());
- sb.append("</LI></UL></DD></DL>");
+ sb.append("</LI></UL></DD>");
return sb.toString();
}
@@ -124,7 +124,7 @@
return toString(tags[0]);
}
final StringBuilder sb = new StringBuilder();
- sb.append("<DL><DT><B>");
+ sb.append("<DT><B>");
sb.append(pluralTitle);
sb.append("</B></DT><DD><UL>");
for (final Tag tag : tags) {
@@ -132,7 +132,7 @@
sb.append(tag.text());
sb.append("</LI>");
}
- sb.append("</UL></DD></DL>");
+ sb.append("</UL></DD>");
return sb.toString();
}
Modified: libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java
===================================================================
--- libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java 2009-07-25 12:55:32 UTC (rev 1362)
+++ libs/taglets/trunk/src/prj/net/sf/japi/taglets/HistoryTaglet.java 2009-07-25 12:55:50 UTC (rev 1363)
@@ -89,11 +89,11 @@
/** {@inheritDoc} */
public String toString(final Tag tag) {
final StringBuilder sb = new StringBuilder();
- sb.append("<DL><DT><B>");
+ sb.append("<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>");
+ sb.append("</TABLE></DD>");
return sb.toString();
}
@@ -107,7 +107,7 @@
return toString(tags[0]);
}
final StringBuilder sb = new StringBuilder();
- sb.append("<DL><DT><B>");
+ sb.append("<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();
@@ -115,7 +115,7 @@
for (final Tag tag : tags) {
append(sb, tag);
}
- sb.append("</TABLE></DD></DL>");
+ sb.append("</TABLE></DD>");
return sb.toString();
}
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