Update of /cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1221
Modified Files:
AbstractProgramElementTagsHandler.java ClassTagsHandler.java
ConstructorTagsHandler.java FieldTagsHandler.java
MethodTagsHandler.java TypeTagsHandler.java
Log Message:
javadoc & tempate tag docs. XDT-1225
Index: AbstractProgramElementTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/AbstractProgramElementTagsHandler.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -r1.16 -r1.17
*** AbstractProgramElementTagsHandler.java 1 Sep 2004 22:43:50 -0000
1.16
--- AbstractProgramElementTagsHandler.java 22 Feb 2005 23:57:25 -0000
1.17
***************
*** 354,363 ****
/**
! * A utility method to get the blank space characters used for indenting
comments.
*
* @param attributes The attributes of the template tag
! * @return The IndentChars value
! * @see
MethodTagsHandler#methodComment(java.util.Properties)
* @see ClassTagsHandler#classComment(java.util.Properties)
*/
protected char[] getIndentChars(Properties attributes)
--- 354,366 ----
/**
! * A utility method to get the blank space characters used for indenting
comments. The number of spaces is read from
! * the <code>indent</code> tag attribute. Defaults to zero spaces if no
<code>indent</code> attribute is present.
*
* @param attributes The attributes of the template tag
! * @return Array of <code>indent</code> space characters
! * @see #memberComment(java.util.Properties, int)
* @see ClassTagsHandler#classComment(java.util.Properties)
+ * @see
ClassTagsHandler#classCommentText(java.util.Properties)
+ * @see
ClassTagsHandler#classCommentTags(java.util.Properties)
*/
protected char[] getIndentChars(Properties attributes)
***************
*** 377,386 ****
/**
! * Describe what the method does
*
! * @param attributes Describe what the parameter does
! * @param forType Describe what the parameter does
! * @return Describe the return value
* @exception XDocletException Describe the exception
*/
protected String exceptionList(Properties attributes, int forType) throws
XDocletException
--- 380,392 ----
/**
! * Return the throws clause of the specified constructor or method
declaration. If no constructor/method is
! * specified, the current one is used.
*
! * @param attributes The attributes of the template tag
! * @param forType Constant indicating constructor or method
! * @return throws clause
* @exception XDocletException Describe the exception
+ * @see
MethodTagsHandler#exceptionList(java.util.Properties)
+ * @see
ConstructorTagsHandler#exceptionList(java.util.Properties)
*/
protected String exceptionList(Properties attributes, int forType) throws
XDocletException
***************
*** 403,407 ****
break;
default:
! throw new XDocletException("Can't forAll for type " + forType);
}
--- 409,413 ----
break;
default:
! throw new XDocletException("Can't exceptionList for type " +
forType);
}
***************
*** 437,441 ****
}
! // append all exceptions specfied to be always appended by default
if (appendExceptions != null) {
appendException(sbuf, appendExceptions);
--- 443,447 ----
}
! // append all exceptions specified to be always appended by default
if (appendExceptions != null) {
appendException(sbuf, appendExceptions);
***************
*** 448,453 ****
* Describe what the method does
*
! * @param template Describe what the parameter does
! * @param attributes Describe what the parameter does
* @param for_type Describe what the parameter does
* @exception XDocletException Describe the exception
--- 454,459 ----
* Describe what the method does
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @param for_type Describe what the parameter does
* @exception XDocletException Describe the exception
***************
*** 503,508 ****
* Describe what the method does
*
! * @param template Describe what the parameter does
! * @param attributes Describe what the parameter does
* @param forType Describe what the parameter does
* @param resourceKey Describe what the parameter does
--- 509,514 ----
* Describe what the method does
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @param forType Describe what the parameter does
* @param resourceKey Describe what the parameter does
***************
*** 584,593 ****
/**
! * @param attributes Describe what the parameter does
! * @param forType Describe what the parameter does
! * @return Describe the return value
* @exception XDocletException Describe the exception
* @todo There is similar functionality in
xjavadoc.XDoc. Use that instead (needs a little
* rework to be more flexible).
*/
protected String memberComment(Properties attributes, int forType) throws
XDocletException
--- 590,604 ----
/**
! * The comment for the current class member of the specified type (field,
constructor or method).
! *
! * @param attributes The attributes of the template tag
! * @param forType Member type
! * @return javadoc comment
* @exception XDocletException Describe the exception
* @todo There is similar functionality in
xjavadoc.XDoc. Use that instead (needs a little
* rework to be more flexible).
+ * @see
MethodTagsHandler#methodComment(java.util.Properties)
+ * @see
FieldTagsHandler#fieldComment(java.util.Properties)
+ * @see
ConstructorTagsHandler#constructorComment(java.util.Properties)
*/
protected String memberComment(Properties attributes, int forType) throws
XDocletException
***************
*** 794,801 ****
/**
! * Describe what the method does
*
! * @param sbuf Describe what the parameter does
! * @param type Describe what the parameter does
*/
private void appendException(StringBuffer sbuf, String type)
--- 805,812 ----
/**
! * Append an exception to the supplied string buffer, building up a
throws clause.
*
! * @param sbuf String buffer containing the throws clause
! * @param type String containing an exception type to add
*/
private void appendException(StringBuffer sbuf, String type)
Index: ClassTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/ClassTagsHandler.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -r1.22 -r1.23
*** ClassTagsHandler.java 10 Oct 2004 23:26:42 -0000 1.22
--- ClassTagsHandler.java 22 Feb 2005 23:57:27 -0000 1.23
***************
*** 631,634 ****
--- 631,636 ----
* @doc.param name="no-comment-signs" optional="true"
values="true,false" description="If true
* then don't decorate the comment with comment signs. Default is
false."
+ * @doc.param name="indent" optional="true"
description="Number of spaces to indent the comment.
+ * Default is 0."
*/
public String classComment(Properties attributes) throws XDocletException
***************
*** 664,667 ****
--- 666,671 ----
* @doc.param name="no-comment-signs" optional="true"
values="true,false" description="If true
* then don't decorate the comment with comment signs. Default is
false."
+ * @doc.param name="indent" optional="true"
description="Number of spaces to indent the comment.
+ * Default is 0."
* @todo handle inline link tags in comment text
*/
***************
*** 691,694 ****
--- 695,700 ----
* @see #classComment(java.util.Properties)
* @doc.tag type="content"
+ * @doc.param name="indent" optional="true"
description="Number of spaces to indent the tags.
+ * Default is 0."
*/
public String classCommentTags(Properties attributes) throws
XDocletException
Index: ConstructorTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/ConstructorTagsHandler.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** ConstructorTagsHandler.java 10 Jul 2004 14:03:26 -0000 1.12
--- ConstructorTagsHandler.java 22 Feb 2005 23:57:28 -0000 1.13
***************
*** 83,86 ****
--- 83,88 ----
* @doc.param name="no-comment-signs" optional="true"
values="true,false" description="If true
* then don't decorate the comment with comment signs."
+ * @doc.param name="indent" optional="true"
description="Number of spaces to indent the comment.
+ * Default is 0."
*/
public String constructorComment(Properties attributes) throws
XDocletException
***************
*** 90,98 ****
/**
! * Iterates over all exceptions thrown by the current constructor and
returns a string containing definition of all
! * those exceptions.
*
* @param attributes The attributes of the template tag
! * @return Description of the Returned Value
* @exception XDocletException Description of Exception
* @doc.tag type="block"
--- 92,100 ----
/**
! * Iterates over all exceptions thrown by the current or specified
constructor and returns a string containing
! * definition of all those exceptions.
*
* @param attributes The attributes of the template tag
! * @return throws clause for the constructor
* @exception XDocletException Description of Exception
* @doc.tag type="block"
***************
*** 102,106 ****
* should be skipped and not put into the list."
* @doc.param name="append" optional="true"
description="A comma-separated list of exceptions that
! * should be always appended regardless if current constructor has
that constructor defined or not."
*/
public String exceptionList(Properties attributes) throws XDocletException
--- 104,108 ----
* should be skipped and not put into the list."
* @doc.param name="append" optional="true"
description="A comma-separated list of exceptions that
! * should be always appended regardless if current constructor has
that exception defined or not."
*/
public String exceptionList(Properties attributes) throws XDocletException
Index: FieldTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/FieldTagsHandler.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** FieldTagsHandler.java 16 May 2004 05:59:25 -0000 1.15
--- FieldTagsHandler.java 22 Feb 2005 23:57:28 -0000 1.16
***************
*** 107,110 ****
--- 107,112 ----
* @doc.param name="no-comment-signs" optional="true"
values="true,false" description="If true
* then don't decorate the comment with comment signs."
+ * @doc.param name="indent" optional="true"
description="Number of spaces to indent the comment.
+ * Default is 0."
*/
public String fieldComment(Properties attributes) throws XDocletException
Index: MethodTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/MethodTagsHandler.java,v
retrieving revision 1.32
retrieving revision 1.33
diff -C2 -r1.32 -r1.33
*** MethodTagsHandler.java 1 Sep 2004 22:43:50 -0000 1.32
--- MethodTagsHandler.java 22 Feb 2005 23:57:28 -0000 1.33
***************
*** 234,238 ****
*
* @param attributes The attributes of the template tag
! * @return comment
* @exception XDocletException Description of Exception
* @see
ClassTagsHandler#classComment(java.util.Properties)
--- 234,238 ----
*
* @param attributes The attributes of the template tag
! * @return javadoc comment
* @exception XDocletException Description of Exception
* @see
ClassTagsHandler#classComment(java.util.Properties)
***************
*** 240,243 ****
--- 240,245 ----
* @doc.param name="no-comment-signs" optional="true"
values="true,false" description="If true
* then don't decorate the comment with comment signs."
+ * @doc.param name="indent" optional="true"
description="Number of spaces to indent the comment.
+ * Default is 0."
*/
public String methodComment(Properties attributes) throws XDocletException
***************
*** 267,275 ****
/**
! * Iterates over all exceptions thrown by the current method and returns
a string containing definition of all those
! * exceptions.
*
* @param attributes The attributes of the template tag
! * @return Description of the Returned Value
* @exception XDocletException Description of Exception
* @doc.tag type="block"
--- 269,277 ----
/**
! * Iterates over all exceptions thrown by the current or specified method
and returns a string containing definition
! * of all those exceptions.
*
* @param attributes The attributes of the template tag
! * @return throws clause for the method
* @exception XDocletException Description of Exception
* @doc.tag type="block"
***************
*** 279,283 ****
* should be skipped and not put into the list."
* @doc.param name="append" optional="true"
description="A comma-separated list of exceptions that
! * should be always appended regardless if current method has that
method defined or not."
*/
public String exceptionList(Properties attributes) throws XDocletException
--- 281,285 ----
* should be skipped and not put into the list."
* @doc.param name="append" optional="true"
description="A comma-separated list of exceptions that
! * should be always appended regardless if current method has that
exception defined or not."
*/
public String exceptionList(Properties attributes) throws XDocletException
Index: TypeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/TypeTagsHandler.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** TypeTagsHandler.java 10 Oct 2004 23:26:42 -0000 1.15
--- TypeTagsHandler.java 22 Feb 2005 23:57:29 -0000 1.16
***************
*** 27,48 ****
/**
! * Used by isOfType. isOfType searches for the type according to the type
parameter. TYPE_CONCRETE_TYPE specifies
! * that only the type of the current entity (class, method return type,
parameter type depdening on the context)
! * should be checked for equality.
*/
public final static int TYPE_CONCRETE_TYPE = 0;
/**
! * Used by isOfType. isOfType searches for the type according to the type
parameter. TYPE_SUPERCLASS specifies that
! * not only the type of the current entity (class, method return type,
parameter type depdening on the context)
! * should be checked for equality, but also direct superclasses and
interfaces of the entity.
*/
public final static int TYPE_SUPERCLASS = 1;
/**
! * Used by isOfType. isOfType searches for the type according to the type
parameter. TYPE_HIERARCHY specifies that
! * not only the type of the current entity (class, method return type,
parameter type depdening on the context)
! * should be checked for equality, but also superclasses and interfaces
of the entity and recursively superclasses
! * and interfaces.
*/
public final static int TYPE_HIERARCHY = 2;
--- 27,48 ----
/**
! * Used by [EMAIL PROTECTED] #isOfType}. The isOfType method searches for
the type according to the type parameter. <code>TYPE_CONCRETE_TYPE</code>
! * specifies that only the type of the current entity (class, method
return type, parameter type depending on the
! * context) should be checked for equality.
*/
public final static int TYPE_CONCRETE_TYPE = 0;
/**
! * Used by [EMAIL PROTECTED] #isOfType}. The isOfType method searches for
the type according to the type parameter. <code>TYPE_SUPERCLASS</code>
! * specifies that not only the type of the current entity (class, method
return type, parameter type depending on
! * the context) should be checked for equality, but also direct
superclasses and interfaces of the entity.
*/
public final static int TYPE_SUPERCLASS = 1;
/**
! * Used by [EMAIL PROTECTED] #isOfType}. The isOfType method searches for
the type according to the type parameter. <code>TYPE_HIERARCHY</code>
! * specifies that not only the type of the current entity (class, method
return type, parameter type depending on
! * the context) should be checked for equality, but also superclasses and
interfaces of the entity and recursively
! * superclasses and interfaces.
*/
public final static int TYPE_HIERARCHY = 2;
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
xdoclet-devel mailing list
xdoclet-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
