User: stevensa
Date: 02/03/09 15:41:54
Modified: core/src/xdoclet/util DocletUtil.java
Log:
Eliminated a few javadoc warnings during build
Revision Changes Path
1.14 +10 -6 xdoclet/core/src/xdoclet/util/DocletUtil.java
Index: DocletUtil.java
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/core/src/xdoclet/util/DocletUtil.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -w -r1.13 -r1.14
--- DocletUtil.java 1 Mar 2002 12:07:37 -0000 1.13
+++ DocletUtil.java 9 Mar 2002 23:41:54 -0000 1.14
@@ -15,7 +15,7 @@
/**
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created July 14, 2001
- * @version $Revision: 1.13 $
+ * @version $Revision: 1.14 $
*/
public final class DocletUtil
{
@@ -25,12 +25,16 @@
}
/**
- * TagName can be in namespace:tag or namespace.tag format
+ * Returns the entire body (parameters etc) of a tag within a supplied Doc
+ * context as text.
*
- * @param doc
- * @param tagName
- * @param superclasses
- * @return
+ * @param doc The Doc subclass (ClassDoc, MethodDoc,
+ * ConstructorDoc or FieldDoc) to search for the tag.
+ * @param tagName The name of the tag. Can be in namespace:tag or
+ * namespace.tag format.
+ * @param superclasses Whether superclass definitions should also be
+ * searched.
+ * @return The tag body
* @exception XDocletException
*/
public static String getText( Doc doc, String tagName, boolean superclasses )
throws XDocletException
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
