Update of /cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25341
Modified Files:
PropertyTagsHandler.java
Log Message:
Javadocs (XDT-1225).
Index: PropertyTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/core/src/xdoclet/tagshandler/PropertyTagsHandler.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** PropertyTagsHandler.java 29 Apr 2003 19:14:21 -0000 1.12
--- PropertyTagsHandler.java 25 Jan 2005 00:51:36 -0000 1.13
***************
*** 15,19 ****
/**
! * PropertyTagsHandler.java
*
* @author <a href="mailto:[EMAIL PROTECTED]">David Jencks</a>
--- 15,19 ----
/**
! * Tags relating to properties. Properties are identified by javabean-style
naming of getters & setters.
*
* @author <a href="mailto:[EMAIL PROTECTED]">David Jencks</a>
***************
*** 27,32 ****
* Searches for the XMethod of the method with name methodName and
returns it. Copied from MethodTagsHandler
*
! * @param methodName Description of Parameter
! * @return The XMethodForMethodName value or null if not found
*/
public static XMethod getXMethodForMethodName(String methodName)
--- 27,32 ----
* Searches for the XMethod of the method with name methodName and
returns it. Copied from MethodTagsHandler
*
! * @param methodName The method to search for
! * @return The matching XMethod or null if not found
*/
public static XMethod getXMethodForMethodName(String methodName)
***************
*** 35,38 ****
--- 35,45 ----
}
+ /**
+ * Searches for the XMethod of the method with name methodName and
returns it. Copied from MethodTagsHandler
+ *
+ * @param methodName The method to search for
+ * @param superclasses Whether to also search superclasses
+ * @return The matching XMethod or null if not found
+ */
public static XMethod getXMethodForMethodName(String methodName, boolean
superclasses)
{
***************
*** 74,83 ****
/**
! * Evaluates the body block for each property of current mbean.You may
set whether superclasses are examined also
* with the superclass attribute. Finds properties with getter, setter,
or both. The getter and setter should have
* javabean naming convention. Only methods with the supplied tag are
considered in looking for properties.
*
* @param template The body of the block tag
! * @param attributes
* @exception XDocletException Description of Exception
* @doc.tag type="block"
--- 81,90 ----
/**
! * Evaluates the body block for each property of current mbean. You may
set whether superclasses are examined also
* with the superclass attribute. Finds properties with getter, setter,
or both. The getter and setter should have
* javabean naming convention. Only methods with the supplied tag are
considered in looking for properties.
*
* @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException Description of Exception
* @doc.tag type="block"
***************
*** 85,89 ****
* properties of superclasses. True by default."
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
! * considered a getter or setter. For example,
jmx:managed-attribute."
*/
public void forAllPropertiesWithTag(String template, Properties
attributes) throws XDocletException
--- 92,97 ----
* properties of superclasses. True by default."
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
! * considered a getter or setter. For example,
jmx.managed-attribute."
! * @todo i18n
*/
public void forAllPropertiesWithTag(String template, Properties
attributes) throws XDocletException
***************
*** 146,155 ****
* look for getters for mbean managed attributes. The get method found
may be the current method.
*
! * @param template a <code>String</code> value
! * @param attributes a <code>Properties</code> value
* @exception XDocletException if an error occurs
* @doc.tag type="block"
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
! * considered a getter or setter. For example,
jmx:managed-attribute."
*/
public void ifHasGetMethodWithTag(String template, Properties attributes)
throws XDocletException
--- 154,163 ----
* look for getters for mbean managed attributes. The get method found
may be the current method.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException if an error occurs
* @doc.tag type="block"
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
! * considered a getter or setter. For example,
jmx.managed-attribute."
*/
public void ifHasGetMethodWithTag(String template, Properties attributes)
throws XDocletException
***************
*** 175,184 ****
* look for setters for mbean managed attributes. The set method found
may be the current method.
*
! * @param template a <code>String</code> value
! * @param attributes a <code>Properties</code> value
* @exception XDocletException if an error occurs
* @doc.tag type="block"
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
! * considered a getter or setter. For example,
jmx:managed-attribute."
*/
public void ifHasSetMethodWithTag(String template, Properties attributes)
throws XDocletException
--- 183,192 ----
* look for setters for mbean managed attributes. The set method found
may be the current method.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @exception XDocletException if an error occurs
* @doc.tag type="block"
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
! * considered a getter or setter. For example,
jmx.managed-attribute."
*/
public void ifHasSetMethodWithTag(String template, Properties attributes)
throws XDocletException
***************
*** 210,213 ****
--- 218,222 ----
* @doc.param name="tagName" optional="false"
description="The required tag for methods to be
* considered a getter or setter. For example,
jmx:managed-attribute."
+ * @todo i18n
*/
public String propertyTypeWithTag(Properties attributes) throws
XDocletException
***************
*** 286,290 ****
*
* @param attributes The attributes of the template tag
! * @param template
* @exception XDocletException Description of Exception
* @doc.tag type="block"
--- 295,299 ----
*
* @param attributes The attributes of the template tag
! * @param template The body of the block tag
* @exception XDocletException Description of Exception
* @doc.tag type="block"
***************
*** 334,340 ****
* Gets the GetMethodWithTag attribute of the PropertyTagsHandler object
*
! * @param attributes Describe what the parameter does
* @return The GetMethodWithTag value
* @exception XDocletException Describe the exception
*/
private XMethod getGetMethodWithTag(Properties attributes) throws
XDocletException
--- 343,350 ----
* Gets the GetMethodWithTag attribute of the PropertyTagsHandler object
*
! * @param attributes The attributes of the template tag
* @return The GetMethodWithTag value
* @exception XDocletException Describe the exception
+ * @todo i18n
*/
private XMethod getGetMethodWithTag(Properties attributes) throws
XDocletException
***************
*** 379,385 ****
* Gets the SetMethodWithTag attribute of the PropertyTagsHandler object
*
! * @param attributes Describe what the parameter does
* @return The SetMethodWithTag value
* @exception XDocletException Describe the exception
*/
private XMethod getSetMethodWithTag(Properties attributes) throws
XDocletException
--- 389,396 ----
* Gets the SetMethodWithTag attribute of the PropertyTagsHandler object
*
! * @param attributes The attributes of the template tag
* @return The SetMethodWithTag value
* @exception XDocletException Describe the exception
+ * @todo i18n
*/
private XMethod getSetMethodWithTag(Properties attributes) throws
XDocletException
-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
_______________________________________________
xdoclet-devel mailing list
xdoclet-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
