User: ko5tik
Date: 02/05/02 10:35:13
Modified: src/java xdoclet-tags.xml
Log:
metawise fixed javadoc comments. It's ready for prime time
Revision Changes Path
1.19 +63 -7 xdocletgui/src/java/xdoclet-tags.xml
Index: xdoclet-tags.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdocletgui/src/java/xdoclet-tags.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -w -r1.18 -r1.19
--- xdoclet-tags.xml 29 Apr 2002 09:04:34 -0000 1.18
+++ xdoclet-tags.xml 2 May 2002 17:35:13 -0000 1.19
@@ -2044,7 +2044,7 @@
<!-- classic javadoc tags -->
<namespace>
<name>classic</name>
- <usage-description>classic javadoc tags like author, param
etc.</usage-description>
+ <usage-description>classic sun-javadoc tags </usage-description>
<condition-description>all classes</condition-description>
<condition type="type">
<condition-parameter>java.lang.Object</condition-parameter>
@@ -2059,8 +2059,36 @@
</condition>
</tag>
<tag>
+ <name>deprecated</name>
+ <usage-description>
+ Adds a comment indicating that this API should no longer be used (even
though it
+ may continue to work). Javadoc moves the deprecated-text ahead of the
description,
+ placing it in italics and preceding it with a bold warning: "Deprecated".
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>class or method level</condition-description>
+ <condition type="and">
+ </condition>
+ </tag>
+ <tag>
+ <name>exception</name>
+ <usage-description>
+ The @throws and @exception tags are synonyms. Adds a "Throws" subheading to
+ the generated documentation, with the class-name and description text. The
+ class-name is the name of the exception that may be thrown by the method.
If this
+ class is not fully-specified, Javadoc uses the search order to look up
this class.
+ </usage-description>
+ <unique>false</unique>
+ <condition-description>class or method level</condition-description>
+ <condition type="and">
+ </condition>
+ </tag>
+ <tag>
<name>param</name>
- <usage-description>describe method parameter</usage-description>
+ <usage-description>
+ Adds a parameter to the "Parameters" section. The description may be
continued on
+ the next line.
+ </usage-description>
<unique>false</unique>
<condition-description>method level</condition-description>
<condition type="method">
@@ -2068,19 +2096,47 @@
</tag>
<tag>
<name>return</name>
- <usage-description>describes method return value</usage-description>
+ <usage-description>
+ Adds a "Returns" section with the description text. This text should
describe the
+ return type and permissible range of values.
+ </usage-description>
<unique>true</unique>
<condition-description>method level</condition-description>
<condition type="method">
</condition>
</tag>
<tag>
- <name>exception</name>
- <usage-description>describe exception thrown by method</usage-description>
+ <name>see</name>
+ <usage-description>
+ Adds a "See Also" heading with a link or text entry that points to
reference. A doc
+ comment may contain any number of @see tags, which are all grouped under
the
+ same heading. The @see tag has three variations; the third form below is
the most
+ common.
+ </usage-description>
<unique>false</unique>
- <condition-description>method level</condition-description>
- <condition type="method">
+ <condition-description>class or method level</condition-description>
+ <condition type="and">
+ </condition>
+ </tag>
+ <tag>
+ <name>serial</name>
+ <usage-description>Used in the doc comment for a default serializable field.
+</usage-description>
+ <unique>true</unique>
+ </tag>
+ <tag>
+ <name>version</name>
+ <usage-description>
+ Adds a "Version" subheading with the specified version-text to the
generated docs
+ when the -version option is used. The text has no special internal
structure. A doc
+ comment may contain at most one @version tag. Version normally refers to
the
+ version of the software (such as the JDK) that contains this class or
member.
+ </usage-description>
+ <unique>true</unique>
+ <condition-description>classlevel</condition-description>
+ <condition type="class">
</condition>
+
</tag>
</tags>
</namespace>
_______________________________________________________________
Have big pipes? SourceForge.net is looking for download mirrors. We supply
the hardware. You get the recognition. Email Us: [EMAIL PROTECTED]
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
