Update of /cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home
In directory sc8-pr-cvs1:/tmp/cvs-serv17060
Modified Files:
HomeTagsHandler.java
Log Message:
Improve javadocs & generated template tag docs.
Index: HomeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/HomeTagsHandler.java,v
retrieving revision 1.32
retrieving revision 1.33
diff -C2 -r1.32 -r1.33
*** HomeTagsHandler.java 25 May 2003 09:15:40 -0000 1.32
--- HomeTagsHandler.java 15 Nov 2003 00:02:42 -0000 1.33
***************
*** 261,266 ****
* Converts ejbHome<em>blabla</em> to home<em>blabla</em> , the one that should
appear in home interface.
*
! * @param methodName Description of Parameter
! * @return Description of the Returned Value
*/
public static String toHomeMethod(String methodName)
--- 261,266 ----
* Converts ejbHome<em>blabla</em> to home<em>blabla</em> , the one that should
appear in home interface.
*
! * @param methodName Method name to be converted.
! * @return Equivalent home interface method name.
*/
public static String toHomeMethod(String methodName)
***************
*** 273,278 ****
* Converts ejbCreate<em>blabla</em> to create<em>blabla</em> , the one that
should appear in home interface.
*
! * @param methodName Description of Parameter
! * @return Description of the Returned Value
*/
public static String toCreateMethod(String methodName)
--- 273,278 ----
* Converts ejbCreate<em>blabla</em> to create<em>blabla</em> , the one that
should appear in home interface.
*
! * @param methodName Method name to be converted.
! * @return Equivalent home interface method name.
*/
public static String toCreateMethod(String methodName)
***************
*** 315,320 ****
* Converts ejbFind<em>blabla</em> to find<em>blabla</em> , the one that should
appear in home interface.
*
! * @param methodName Description of Parameter
! * @return Description of the Returned Value
*/
public static String toFinderMethod(String methodName)
--- 315,320 ----
* Converts ejbFind<em>blabla</em> to find<em>blabla</em> , the one that should
appear in home interface.
*
! * @param methodName Method name to be converted.
! * @return Equivalent home interface method name.
*/
public static String toFinderMethod(String methodName)
***************
*** 325,332 ****
/**
! * Describe what the method does
*
! * @param s Describe what the parameter does
! * @return Describe the return value
*/
public static String fullPackageChange(String s)
--- 325,332 ----
/**
! * Convert various collection types within a string to their fully qualified
forms.
*
! * @param s String to be converted.
! * @return String with fully qualified collection types.
*/
public static String fullPackageChange(String s)
***************
*** 654,658 ****
/**
! * Iterates over all finder methods defined in a class and super classes
*
* @param template The body of the block tag
--- 654,658 ----
/**
! * Iterates over all home methods of specified type (finder or create method)
defined in a class and super classes.
*
* @param template The body of the block tag
***************
*** 660,664 ****
* @exception XDocletException
* @doc.tag type="block"
! * @doc.param name="tagName" optional="false" description="The
tag name."
* @doc.param name="superclasses" values="true,false"
description="If true then traverse
* superclasses also, otherwise look up the tag in current concrete class
only."
--- 660,665 ----
* @exception XDocletException
* @doc.tag type="block"
! * @doc.param name="tagName" optional="false" description="The
tag name for the method type to
! * iterate over." values="ejb:finder,ejb:create-method"
* @doc.param name="superclasses" values="true,false"
description="If true then traverse
* superclasses also, otherwise look up the tag in current concrete class
only."
***************
*** 949,953 ****
/**
! * Describe what the method does
*
* @return Describe the return value
--- 950,954 ----
/**
! * Return signature of current home method.
*
* @return Describe the return value
***************
*** 959,962 ****
--- 960,970 ----
}
+ /**
+ * Return permission for current home method.
+ *
+ * @return
+ * @exception XDocletException
+ * @doc.tag type="content"
+ */
public String currentPermission() throws XDocletException
{
***************
*** 964,967 ****
--- 972,982 ----
}
+ /**
+ * Return type of current home method.
+ *
+ * @return
+ * @exception XDocletException
+ * @doc.tag type="content"
+ */
public String currentType() throws XDocletException
{
***************
*** 1001,1004 ****
--- 1016,1020 ----
* @param param
* @exception XDocletException
+ * @doc.tag type="block"
*/
public void ifIsCollectionType(String template, Properties param) throws
XDocletException
***************
*** 1020,1023 ****
--- 1036,1040 ----
* @param param
* @exception XDocletException
+ * @doc.tag type="block"
*/
public void ifIsEnumerationType(String template, Properties param) throws
XDocletException
***************
*** 1036,1040 ****
* @param param
* @exception XDocletException
! * @doc.tag type="content"
*/
public void ifIsInterfaceType(String template, Properties param) throws
XDocletException
--- 1053,1057 ----
* @param param
* @exception XDocletException
! * @doc.tag type="block"
*/
public void ifIsInterfaceType(String template, Properties param) throws
XDocletException
***************
*** 1049,1052 ****
--- 1066,1076 ----
}
+ /**
+ * Return name of current home method.
+ *
+ * @return Describe the return value
+ * @exception XDocletException
+ * @doc.tag type="content"
+ */
public String currentMethod() throws XDocletException
{
***************
*** 1061,1067 ****
}
-
/**
! * return definition of parameter list for definition for current home method
*
* @return
--- 1085,1090 ----
}
/**
! * Return definition of parameter list for current home method.
*
* @return
***************
*** 1082,1086 ****
/**
! * Return parameter list for invocation.
*
* @return
--- 1105,1109 ----
/**
! * Return parameter list for current home method.
*
* @return
***************
*** 1104,1111 ****
/**
! * Describe what the method does
*
! * @return Describe the return value
* @exception XDocletException
*/
public String currentExceptions() throws XDocletException
--- 1127,1135 ----
/**
! * Return exceptions for current home method.
*
! * @return
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String currentExceptions() throws XDocletException
-------------------------------------------------------
This SF. Net email is sponsored by: GoToMyPC
GoToMyPC is the fast, easy and secure way to access your computer from
any Web browser or wireless device. Click here to Try it Free!
https://www.gotomypc.com/tr/OSDN/AW/Q4_2003/t/g22lp?Target=mm/g22lp.tmpl
_______________________________________________
xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
