Update of /cvsroot/xdoclet/xdoclet/modules/wsee/src/xdoclet/modules/wsee
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11906
Modified Files:
WseeTagsHandler.java
Log Message:
Javadocs (XDT-1225)
Index: WseeTagsHandler.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/wsee/src/xdoclet/modules/wsee/WseeTagsHandler.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** WseeTagsHandler.java 4 Apr 2005 16:12:17 -0000 1.4
--- WseeTagsHandler.java 14 Apr 2005 00:46:03 -0000 1.5
***************
*** 38,44 ****
{
/**
! * constants
*/
public final static String PORT_COMPONENT = "wsee.port-component";
public final static String HANDLER = "wsee.handler";
--- 38,47 ----
{
/**
! * name of javadoc tag indicating a port component
*/
public final static String PORT_COMPONENT = "wsee.port-component";
+ /**
+ * name of javadoc tag indicating a handler
+ */
public final static String HANDLER = "wsee.handler";
***************
*** 51,55 ****
* check whether the given class is a port component
*
! * @param clazz
* @return
* @exception XDocletException
--- 54,58 ----
* check whether the given class is a port component
*
! * @param clazz class
* @return
* @exception XDocletException
***************
*** 62,69 ****
/**
! * Gets a namespace for the package
*
! * @param pak Describe what the parameter does
! * @return The PackageNameFor value
*/
public static String getNamespaceForPackage(XPackage pak)
--- 65,73 ----
/**
! * Gets the namespace for the specified package.
*
! * @param pak package
! * @return namespace
! * @see #getNamespaceForPackage(java.lang.String)
*/
public static String getNamespaceForPackage(XPackage pak)
***************
*** 73,80 ****
/**
! * Gets a namespace for the package
*
! * @param pak Describe what the parameter does
! * @return The PackageNameFor value
*/
public static String getNamespaceForPackage(String pak)
--- 77,84 ----
/**
! * Gets the namespace for the specified package.
*
! * @param pak package
! * @return namespace
*/
public static String getNamespaceForPackage(String pak)
***************
*** 99,120 ****
/**
! * Gets the PackageSubstitutions attribute of the PackageTagsHandler class
*
! * @return The PackageSubstitutions value
*/
public static List getPackageNamespaceMappings()
{
! // SubTask's packageSubstitutions has precedence over
! // the global packageSubstitutions defined in DocletTask
! List packageSubstitutions = (List)
DocletContext.getInstance().getConfigParam("packageNamespaceMappings");
! return packageSubstitutions;
}
/**
! * return the namespace of the current clazz
*
! * @param clazz
! * @return
* @exception XDocletException
*/
--- 103,124 ----
/**
! * Gets the package-namespace mappings for the subtask.
*
! * @return List of packageNamespaceMapping config params
*/
public static List getPackageNamespaceMappings()
{
! // SubTask's packageNamespaceMappings has precedence over
! // the global packageNamespaceMappings defined in DocletTask
! List packageNamespaceMappings = (List)
DocletContext.getInstance().getConfigParam("packageNamespaceMappings");
! return packageNamespaceMappings;
}
/**
! * return the namespace of the specified class
*
! * @param clazz class
! * @return namespace URI
* @exception XDocletException
*/
***************
*** 171,177 ****
* returns the service endpoint interface name belonging to the current
class
*
! * @param props
* @return
* @exception XDocletException
*/
public String serviceEndpoint(Properties props) throws XDocletException
--- 175,182 ----
* returns the service endpoint interface name belonging to the current
class
*
! * @param props The attributes of the template tag
* @return
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String serviceEndpoint(Properties props) throws XDocletException
***************
*** 212,218 ****
* returns the service endpoint link pointing to the current class
*
! * @param props
* @return
* @exception XDocletException
*/
public String serviceEndpointLink(Properties props)
--- 217,224 ----
* returns the service endpoint link pointing to the current class
*
! * @param props The attributes of the template tag
* @return
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String serviceEndpointLink(Properties props)
***************
*** 239,242 ****
--- 245,249 ----
* @return
* @exception XDocletException
+ * @doc.tag type="content"
*/
public String namespaceURI()
***************
*** 265,273 ****
/**
! * Iterates over all handler tags annotating the current class
*
! * @param template
! * @param attributes
* @throws XDocletException
*/
public void forAllHandlers(String template, Properties attributes)
--- 272,281 ----
/**
! * Iterates over all handler tags annotating the current class.
*
! * @param template The body of the block tag
! * @param attributes The attributes of the template tag
* @throws XDocletException
+ * @doc.tag type="block"
*/
public void forAllHandlers(String template, Properties attributes)
***************
*** 287,293 ****
* conditional checking presence of a handler tag
*
! * @param template
! * @param props
* @exception XDocletException
*/
public void ifHasHandlerTag(String template, Properties props)
--- 295,303 ----
* conditional checking presence of a handler tag
*
! * @param template The body of the block tag
! * @param props The attributes of the template tag
* @exception XDocletException
+ * @doc.tag type="block"
+ * @doc.param name="paramName" optional="false"
description="The name of the parameter"
*/
public void ifHasHandlerTag(String template, Properties props)
***************
*** 300,308 ****
/**
! * extrace the value of the current handler tag
*
! * @param props
* @return
* @exception XDocletException
*/
public String handlerTagValue(Properties props) throws XDocletException
--- 310,320 ----
/**
! * extract the value of the current handler tag
*
! * @param props The attributes of the template tag
* @return
* @exception XDocletException
+ * @doc.tag type="content"
+ * @doc.param name="paramName" optional="false"
description="The name of the parameter"
*/
public String handlerTagValue(Properties props) throws XDocletException
***************
*** 314,320 ****
* conditional to handle per class wsdl
*
! * @param template
! * @param props
* @throws XDocletException
*/
public void ifWsdlPerClass(String template, Properties props) throws
XDocletException
--- 326,333 ----
* conditional to handle per class wsdl
*
! * @param template The body of the block tag
! * @param props The attributes of the template tag
* @throws XDocletException
+ * @doc.tag type="block"
*/
public void ifWsdlPerClass(String template, Properties props) throws
XDocletException
***************
*** 327,333 ****
* conditional to handle single wsdl generation
*
! * @param template
! * @param props
* @throws XDocletException
*/
public void ifNotWsdlPerClass(String template, Properties props) throws
XDocletException
--- 340,347 ----
* conditional to handle single wsdl generation
*
! * @param template The body of the block tag
! * @param props The attributes of the template tag
* @throws XDocletException
+ * @doc.tag type="block"
*/
public void ifNotWsdlPerClass(String template, Properties props) throws
XDocletException
***************
*** 338,347 ****
/**
! * Constructs a guestimated filename for the wsdl file. It also attemts
to decide if the file should be in META-INF
! * or WEB-INF. This should yeild a filename that will be correct for use
within the webservices.xml file.
*
* @param props If prefixWithPackageStructure is specified for the wsdl
sub task, the property
* prefixWithPackage="true" will need to be specified.
! * @return
*/
public String wsdlFilename(Properties props)
--- 352,364 ----
/**
! * Constructs a guestimated filename for the wsdl file. It also attempts
to decide if the file should be in META-INF
! * or WEB-INF. This should yield a filename that will be correct for use
within the webservices.xml file.
*
* @param props If prefixWithPackageStructure is specified for the wsdl
sub task, the property
* prefixWithPackage="true" will need to be specified.
! * @return filename
! * @doc.tag type="content"
! * @doc.param name="prefixWithPackage" optional="true"
values="true,false" description="Whether to prefix the
! * filename with the package hierarchy."
*/
public String wsdlFilename(Properties props)
***************
*** 381,389 ****
/**
! * Constructs a guestimated filename for the jaxrpc file
*
! * @param props If prefixWithPackageStructur is specified for the wsdl
sub task, the property
* prefixWithPackage="true" will need to be specified.
! * @return
*/
public String jaxrpcMappingFilename(Properties props)
--- 398,409 ----
/**
! * Constructs a guestimated filename for the jaxrpc file.
*
! * @param props If prefixWithPackageStructure is specified for the wsdl
sub task, the property
* prefixWithPackage="true" will need to be specified.
! * @return filename
! * @doc.tag type="content"
! * @doc.param name="prefixWithPackage" optional="true"
values="true,false" description="Whether to prefix the
! * filename with the package hierarchy."
*/
public String jaxrpcMappingFilename(Properties props)
***************
*** 444,448 ****
* Get the value of the wsdl file pattern
*
! * @return
*/
protected String getWsdlFilePattern()
--- 464,468 ----
* Get the value of the wsdl file pattern
*
! * @return pattern
*/
protected String getWsdlFilePattern()
***************
*** 461,467 ****
/**
! * Get the value of the wsdl file pattern
*
! * @return
*/
protected String getJaxrpcFilePattern()
--- 481,487 ----
/**
! * Get the value of the jaxrpc file pattern
*
! * @return pattern
*/
protected String getJaxrpcFilePattern()
-------------------------------------------------------
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
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
