User: pathoss
Date: 02/05/15 12:19:28
Modified: modules/ejb/src/xdoclet/modules/ejb/home Tag:
MODULE_REFACTORING_BRANCH HomeInterfaceSubTask.java
HomeTagsHandler.java LocalHomeInterfaceSubTask.java
Log:
Removed todo-javadoc.
Revision Changes Path
No revision
No revision
1.1.2.9 +1 -11
xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/Attic/HomeInterfaceSubTask.java
Index: HomeInterfaceSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/Attic/HomeInterfaceSubTask.java,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -w -r1.1.2.8 -r1.1.2.9
--- HomeInterfaceSubTask.java 14 May 2002 20:41:28 -0000 1.1.2.8
+++ HomeInterfaceSubTask.java 15 May 2002 19:19:28 -0000 1.1.2.9
@@ -27,7 +27,7 @@
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created Oct 15, 2001
* @xdoclet:subtask name="homeinterface"
parent="xdoclet.modules.ejb.EjbDocletTask"
- * @version $Revision: 1.1.2.8 $
+ * @version $Revision: 1.1.2.9 $
*/
public class HomeInterfaceSubTask extends AbstractEjbCodeGeneratorSubTask
{
@@ -48,8 +48,6 @@
/**
* Describe what the HomeInterfaceSubTask constructor does
- *
- * @todo-javadoc Write javadocs for constructor
*/
public HomeInterfaceSubTask()
{
@@ -130,8 +128,6 @@
* @param clazz Describe what the parameter does
* @return The GeneratedFileName value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for exception
*/
protected String getGeneratedFileName(XClass clazz) throws XDocletException
{
@@ -145,10 +141,6 @@
* @param clazz Describe what the parameter does
* @return Describe the return value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for return value
- * @todo-javadoc Write javadocs for exception
*/
protected boolean matchesGenerationRules(XClass clazz) throws XDocletException
{
@@ -184,8 +176,6 @@
* Describe what the method does
*
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for exception
*/
protected void engineStarted() throws XDocletException
{
1.1.2.6 +48 -111
xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/Attic/HomeTagsHandler.java
Index: HomeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/Attic/HomeTagsHandler.java,v
retrieving revision 1.1.2.5
retrieving revision 1.1.2.6
diff -u -w -r1.1.2.5 -r1.1.2.6
--- HomeTagsHandler.java 13 May 2002 11:19:26 -0000 1.1.2.5
+++ HomeTagsHandler.java 15 May 2002 19:19:28 -0000 1.1.2.6
@@ -33,47 +33,32 @@
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created Oct 15, 2001
* @xdoclet:taghandler namespace="EjbHome"
- * @version $Revision: 1.1.2.5 $
+ * @version $Revision: 1.1.2.6 $
*/
public class HomeTagsHandler extends EjbTagsHandler
{
- /**
- * @todo-javadoc Describe the field
- */
private String currentSignature;
- /**
- * @todo-javadoc Describe the field
- */
+
private String currentExceptions;
/**
- * Similar to {@link
src.xdoclet.modules.ejb.intf.InterfaceTagsHandler#getComponentInterface}.
- * Relies on the ejb:home tag, which has the following relevant properties:
- *
+ * Similar to {@link
src.xdoclet.modules.ejb.intf.InterfaceTagsHandler#getComponentInterface}. Relies on the
+ * ejb:home tag, which has the following relevant properties:
* <ul>
- * <li> remote-class: The fully qualified name of the remote class -
- * overrides all set patterns
- * <li> local-class: The fully qualified name of the local class -
- * overrides all set patterns
- * <li> remote-pattern: The pattern to be used to determine the
- * unqualified name of the remote class
- * <li> local-pattern: The pattern to be used to determine the unqualified
- * name of the local class
- * <li> pattern: The pattern to be used in determining the unqualified
- * remote and/or local home interface name - used where remote- or local-
- * pattern are not specified.
- * <li> remote-package: The package the remote home interface is to be
- * placed in
- * <li> local-package: The package the local home interface is to be
- * placed in
- * <li> package: The package the remote and/or local home interface is to
- * be placed in - used where remote- or local- package are not specified.
- *
+ * <li> remote-class: The fully qualified name of the remote class -
overrides all set patterns
+ * <li> local-class: The fully qualified name of the local class - overrides
all set patterns
+ * <li> remote-pattern: The pattern to be used to determine the unqualified
name of the remote class
+ * <li> local-pattern: The pattern to be used to determine the unqualified
name of the local class
+ * <li> pattern: The pattern to be used in determining the unqualified remote
and/or local home interface name -
+ * used where remote- or local- pattern are not specified.
+ * <li> remote-package: The package the remote home interface is to be placed
in
+ * <li> local-package: The package the local home interface is to be placed in
+ * <li> package: The package the remote and/or local home interface is to be
placed in - used where remote- or
+ * local- package are not specified.
* </ul>
*
*
- * @param type The type of home interface - can be remote
- * or local.
+ * @param type The type of home interface - can be remote or
local.
* @param clazz Description of Parameter
* @return The HomeInterface value
* @exception XDocletException
@@ -153,8 +138,7 @@
}
/**
- * Returns true if method is a create method marked with a ejb:create-method
- * tag, false otherwise.
+ * Returns true if method is a create method marked with a ejb:create-method
tag, false otherwise.
*
* @param method Description of Parameter
* @return The CreateMethod value
@@ -166,8 +150,7 @@
}
/**
- * Returns true if method is a home method marked with a ejb:home-method
- * tag, false otherwise.
+ * Returns true if method is a home method marked with a ejb:home-method tag,
false otherwise.
*
* @param method Description of Parameter
* @return The HomeMethod value
@@ -185,9 +168,6 @@
* @param type Describe what the parameter does
* @return The CompNameFor value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for exception
*/
public static String getCompNameFor(XClass clazz, String type) throws
XDocletException
{
@@ -221,11 +201,6 @@
* @param type Describe what the parameter does
* @return The HomeDefinition value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for exception
*/
public static String getHomeDefinition(XClass clazz, XMethod method, String
tagType, String type)
throws XDocletException
@@ -270,8 +245,7 @@
}
/**
- * Converts ejbHome<em>blabla</em> to home<em>blabla</em> , the one that
- * should appear in home interface.
+ * 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
@@ -284,8 +258,7 @@
}
/**
- * Converts ejbCreate<em>blabla</em> to create<em>blabla</em> , the one that
- * should appear in home interface.
+ * 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
@@ -308,10 +281,6 @@
* @param clazz Describe what the parameter does
* @return Describe the return value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for return value
- * @todo-javadoc Write javadocs for exception
*/
public static XMethod findFirstCreateMethodFor(XClass clazz) throws
XDocletException
{
@@ -333,8 +302,7 @@
}
/**
- * Converts ejbFind<em>blabla</em> to find<em>blabla</em> , the one that
- * should appear in home interface.
+ * 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
@@ -351,9 +319,6 @@
*
* @param s Describe what the parameter does
* @return Describe the return value
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for return value
*/
public static String fullPackageChange(String s)
{
@@ -411,16 +376,15 @@
}
/**
- * Returns the full qualified local or remote home interface name for the
- * bean, depending on the value of type parameter.
+ * Returns the full qualified local or remote home interface name for the bean,
depending on the value of type
+ * parameter.
*
* @param attributes The attributes of the template tag
* @return Description of the Returned Value
* @exception XDocletException
* @doc:tag type="content"
- * @doc:param name="type" optional="false"
- * values="remote,local" description="Specifies the type of component
- * home interface."
+ * @doc:param name="type" optional="false"
values="remote,local" description="Specifies the type
+ * of component home interface."
*/
public String homeInterface(Properties attributes) throws XDocletException
{
@@ -432,19 +396,17 @@
}
/**
- * Evaluates the body block if current method is a create method. Create
- * methods should have ejb:create-method defined.
+ * Evaluates the body block if current method is a create method. Create
methods should have ejb:create-method
+ * defined.
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @exception XDocletException
- * @todo I commented somehting strange but surely
- * needed
+ * @todo I commented somehting strange but surely needed
* @see #isCreateMethod(xjavadoc.XMethod)
* @doc:tag type="block"
- * @doc:param name="superclasses" optional="true"
- * description="Traverse superclasses too. With false value used in
- * remote/local home interface templates. Default is False."
+ * @doc:param name="superclasses" optional="true"
description="Traverse superclasses too. With
+ * false value used in remote/local home interface templates. Default is
False."
*/
public void ifIsCreateMethod(String template, Properties attributes) throws
XDocletException
{
@@ -464,8 +426,7 @@
}
/**
- * Evaluates the body block if current create method's ejbPostCreate method
- * does not exist.
+ * Evaluates the body block if current create method's ejbPostCreate method
does not exist.
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
@@ -494,8 +455,7 @@
}
/**
- * Returns the appropriate ejbPostCreate method name for the current
- * ejbCreate method.
+ * Returns the appropriate ejbPostCreate method name for the current ejbCreate
method.
*
* @param attributes The attributes of the template tag
* @return Description of the Returned Value
@@ -510,17 +470,15 @@
}
/**
- * Evaluates the body block if current method is a home method. Home methods
- * should have ejb:home-method defined.
+ * Evaluates the body block if current method is a home method. Home methods
should have ejb:home-method defined.
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @exception XDocletException
* @see #isHomeMethod(xjavadoc.XMethod)
* @doc:tag type="block"
- * @doc:param name="superclasses" optional="true"
- * description="Traverse superclasses too. With false value used in
- * remote/local home interface templates. Default is False."
+ * @doc:param name="superclasses" optional="true"
description="Traverse superclasses too. With
+ * false value used in remote/local home interface templates. Default is
False."
*/
public void ifIsHomeMethod(String template, Properties attributes) throws
XDocletException
{
@@ -582,12 +540,10 @@
* @return Description of the Returned Value
* @exception XDocletException
* @doc:tag type="content"
- * @doc:param name="prefixWithEjbSlash" optional="true"
- * values="true,false" description="Specifies whether to prefix it with
- * ejb/ or not. False by default."
- * @doc:param name="type" optional="false"
- * values="remote,local" description="Specifies if we want the jndi
- * name value for local or remote lookup."
+ * @doc:param name="prefixWithEjbSlash" optional="true"
values="true,false" description="Specifies
+ * whether to prefix it with ejb/ or not. False by default."
+ * @doc:param name="type" optional="false"
values="remote,local" description="Specifies if we want
+ * the jndi name value for local or remote lookup."
*/
public String compName(Properties attributes) throws XDocletException
{
@@ -614,9 +570,8 @@
* @return Description of the Returned Value
* @exception XDocletException
* @doc:tag type="content"
- * @doc:param name="type" optional="false"
- * values="remote,local" description="Specifies if we want the jndi
- * name value for local or remote lookup."
+ * @doc:param name="type" optional="false"
values="remote,local" description="Specifies if we want
+ * the jndi name value for local or remote lookup."
*/
public String jndiName(Properties attributes) throws XDocletException
{
@@ -667,17 +622,13 @@
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @exception XDocletException
- * @todo skip EJBException as we do in home.j for
- * home-methods
+ * @todo skip EJBException as we do in home.j for
home-methods
* @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."
- * @doc:param name="tagKey" description="A tag property
- * that will be used as a unique key. This is used to avoid duplicate
- * code due to similar tags in superclasses."
+ * @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."
+ * @doc:param name="tagKey" description="A tag property that
will be used as a unique key. This is
+ * used to avoid duplicate code due to similar tags in superclasses."
*/
public void forAllHomeMethods(String template, Properties attributes) throws
XDocletException
{
@@ -923,9 +874,6 @@
*
* @return Describe the return value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for return value
- * @todo-javadoc Write javadocs for exception
*/
public String currentSignature() throws XDocletException
{
@@ -937,9 +885,6 @@
*
* @return Describe the return value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for return value
- * @todo-javadoc Write javadocs for exception
*/
public String currentExceptions() throws XDocletException
{
@@ -953,9 +898,6 @@
* @param type Describe what the parameter does
* @return The DependentClassFor value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for exception
*/
protected String getDependentClassFor(XClass clazz, String type) throws
XDocletException
{
@@ -994,11 +936,6 @@
* @param tag_name Describe what the parameter does
* @return Describe the return value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for return value
- * @todo-javadoc Write javadocs for exception
*/
protected boolean shouldTraverseSuperclassForDependentClass(XClass clazz,
String tag_name) throws XDocletException
{
1.1.2.9 +1 -11
xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/Attic/LocalHomeInterfaceSubTask.java
Index: LocalHomeInterfaceSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/ejb/src/xdoclet/modules/ejb/home/Attic/LocalHomeInterfaceSubTask.java,v
retrieving revision 1.1.2.8
retrieving revision 1.1.2.9
diff -u -w -r1.1.2.8 -r1.1.2.9
--- LocalHomeInterfaceSubTask.java 14 May 2002 20:41:28 -0000 1.1.2.8
+++ LocalHomeInterfaceSubTask.java 15 May 2002 19:19:28 -0000 1.1.2.9
@@ -26,7 +26,7 @@
* @author Ara Abrahamian ([EMAIL PROTECTED])
* @created Oct 15, 2001
* @xdoclet:subtask name="localhomeinterface"
parent="xdoclet.modules.ejb.EjbDocletTask"
- * @version $Revision: 1.1.2.8 $
+ * @version $Revision: 1.1.2.9 $
*/
public class LocalHomeInterfaceSubTask extends AbstractEjbCodeGeneratorSubTask
{
@@ -47,8 +47,6 @@
/**
* Describe what the LocalHomeInterfaceSubTask constructor does
- *
- * @todo-javadoc Write javadocs for constructor
*/
public LocalHomeInterfaceSubTask()
{
@@ -120,8 +118,6 @@
* @param clazz Describe what the parameter does
* @return The GeneratedFileName value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for exception
*/
protected String getGeneratedFileName(XClass clazz) throws XDocletException
{
@@ -134,10 +130,6 @@
* @param clazz Describe what the parameter does
* @return Describe the return value
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for method parameter
- * @todo-javadoc Write javadocs for return value
- * @todo-javadoc Write javadocs for exception
*/
protected boolean matchesGenerationRules(XClass clazz) throws XDocletException
{
@@ -172,8 +164,6 @@
* Describe what the method does
*
* @exception XDocletException
- * @todo-javadoc Write javadocs for method
- * @todo-javadoc Write javadocs for exception
*/
protected void engineStarted() throws XDocletException
{
_______________________________________________________________
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
