axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From di...@apache.org
Subject svn commit: r373529 - in /webservices/axis/trunk/c/include/axis: AxisException.hpp AxisUserAPI.hpp IAttribute.hpp INamespace.hpp ISoapFault.hpp client/Call.hpp client/Stub.hpp
Date Mon, 30 Jan 2006 15:27:22 GMT
Author: dicka
Date: Mon Jan 30 07:27:16 2006
New Revision: 373529

URL: http://svn.apache.org/viewcvs?rev=373529&view=rev
Log:
Some updates to API documentation to reduce number if doxygen warnings and errors.

Modified:
    webservices/axis/trunk/c/include/axis/AxisException.hpp
    webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp
    webservices/axis/trunk/c/include/axis/IAttribute.hpp
    webservices/axis/trunk/c/include/axis/INamespace.hpp
    webservices/axis/trunk/c/include/axis/ISoapFault.hpp
    webservices/axis/trunk/c/include/axis/client/Call.hpp
    webservices/axis/trunk/c/include/axis/client/Stub.hpp

Modified: webservices/axis/trunk/c/include/axis/AxisException.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/AxisException.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/AxisException.hpp (original)
+++ webservices/axis/trunk/c/include/axis/AxisException.hpp Mon Jan 30 07:27:16 2006
@@ -19,7 +19,7 @@
  */
 
 /**
- * @file AxisException.h
+ * @file AxisException.hpp
  *
  * @author Damitha Kumarage (damitha@opensource.lk, damitha@jkcsworld.com)
  *

Modified: webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp (original)
+++ webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp Mon Jan 30 07:27:16 2006
@@ -275,12 +275,48 @@
  */
 class STORAGE_CLASS_INFO xsd__base64Binary {
 public:
+
+    /**
+     * Default constructor
+     */
     xsd__base64Binary();
+    
+    /**
+     * Copy Constructor
+     * @param original xsd__base64Binary object to be copied.
+     */
 	xsd__base64Binary(const xsd__base64Binary & original);
+   
+   /**
+    * Destructor
+    */
     ~xsd__base64Binary();
+    
+    /**
+     * Set binary data into xsd__base64Binary object.
+     * @param data binary data
+     * @param size length, in bytes, of binary data
+     */
 	void set(xsd__unsignedByte * data, xsd__int size);
+   
+    /**
+     * Get binary data from xsd__base64Binary object.
+     * @param size is updated with length, in bytes, of binary data
+     * @return binary data
+     */
 	xsd__unsignedByte * get(xsd__int & size) const;
+  
+    /**
+     * Get length, in bytes, of binary data.
+     * @return length, in bytes, of binary data
+     */
 	xsd__int getSize(void) const;
+    
+    /**
+     * Assignment operator
+     * @param original xsd__base64Binary object from which data is to be assigned
+     * @return reference to this
+     */
 	xsd__base64Binary & operator=(const xsd__base64Binary & original);
 private:
     xsd__unsignedByte * __ptr;

Modified: webservices/axis/trunk/c/include/axis/IAttribute.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/IAttribute.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/IAttribute.hpp (original)
+++ webservices/axis/trunk/c/include/axis/IAttribute.hpp Mon Jan 30 07:27:16 2006
@@ -16,7 +16,7 @@
  */
 
  /**
- * @file IAttribute.h
+ * @file IAttribute.hpp
  *
  *
  */

Modified: webservices/axis/trunk/c/include/axis/INamespace.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/INamespace.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/INamespace.hpp (original)
+++ webservices/axis/trunk/c/include/axis/INamespace.hpp Mon Jan 30 07:27:16 2006
@@ -16,7 +16,7 @@
  */
 
  /**
- * @file INamespace.h
+ * @file INamespace.hpp
  *
  *
  */

Modified: webservices/axis/trunk/c/include/axis/ISoapFault.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/ISoapFault.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/ISoapFault.hpp (original)
+++ webservices/axis/trunk/c/include/axis/ISoapFault.hpp Mon Jan 30 07:27:16 2006
@@ -16,7 +16,7 @@
  */
 
 /**
- * @file ISoapFault.h
+ * @file ISoapFault.hpp
  *
  * @author Damitha Kumarage (damitha@opensource.lk, damitha@jkcsworld.com)
  *

Modified: webservices/axis/trunk/c/include/axis/client/Call.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/client/Call.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/client/Call.hpp (original)
+++ webservices/axis/trunk/c/include/axis/client/Call.hpp Mon Jan 30 07:27:16 2006
@@ -17,7 +17,7 @@
  */
 
  /**
- * @file Call.h
+ * @file Call.hpp
  *
  * This file Contains the Call class and equivalent C function tables
  * that all web service stubs generated by WSDL2Ws tool use to talk

Modified: webservices/axis/trunk/c/include/axis/client/Stub.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/client/Stub.hpp?rev=373529&r1=373528&r2=373529&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/client/Stub.hpp (original)
+++ webservices/axis/trunk/c/include/axis/client/Stub.hpp Mon Jan 30 07:27:16 2006
@@ -17,7 +17,7 @@
  */
 
  /**
- * @file Stub.h
+ * @file Stub.hpp
  *
  * Contains the Stub base class that all C++ web service stubs inherit
  * from. The functions in this Stub base class provides the client
@@ -147,7 +147,7 @@
     * This method advances the iterator by one position.
     * Repeated calls always retuen the next value.
     *
-    * @param whether the response or outgoing message should be used
+    * @param response whether the response or outgoing message should be used
     * @return Next transport property key. If there are no transport 
     * properties set or if iterator is at the end of the list, returns NULL.
     */
@@ -188,7 +188,7 @@
     * Repeated calls always retuen the same value unless 
     * getNextTransportPropertyKey() is called in between.
     *
-    * @param whether the response or outgoing message should be used
+    * @param response whether the response or outgoing message should be used
     * @return Current transport property value. If there are no transport 
     * properties set or if iterator is at the end of the list, returns NULL.
     */
@@ -197,7 +197,7 @@
   /**
     * Deletes the transport property key:value pair currently pointed to by 
     * the iterator.
-    * @param true if it's the response property or false for the request
+    * @param response true if it's the response property or false for the request
     */
     void deleteCurrentTransportProperty(bool response=true);
 
@@ -239,53 +239,75 @@
     * 
     * This will create a header block that would look like the following when 
     * serialized:
-    * <PRE>
-    *   <th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
-    *   </th:TestHeader>
-    * </PRE>
+    * \verbatim
+<th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
+</th:TestHeader>
+\endverbatim
     *
     * User must use the IHeaderBlock pointer returned and fill in the header structure.
     * e.g. To make the SOAP header look like
-    * <PRE>
-    * <SOAP-ENV:Header>
-    *   <th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
-    *       <Credentials>
-    *            <username>Test User</username>
-    *            <password>Test Password</password>
-    *       </Credentials>
-    *   </th:TestHeader>
-    * </SOAP-ENV:Header>
-    * </PRE>
-    * the following code segment coule be used
-    * <PRE>
+    * \verbatim
+<SOAP-ENV:Header>
+    <th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
+        <Credentials>
+            <username>Test User</username>
+            <password>Test Password</password>
+        </Credentials>
+        </th:TestHeader>
+</SOAP-ENV:Header>
+\endverbatim
+    * the following code segment could be used
+    * <code>
+    * 
     *  IHeaderBlock *phb = ws.createSOAPHeaderBlock("TestHeader",
     *                                   "http://ws.apache.org/axisCppTest/");
+    * 
     *  //Note: The prefix will be added automaticaly.
+    * 
     *  //create parent node
+    * 
     *  BasicNode *parentNode = phb->createChild(ELEMENT_NODE);
+    * 
     *  parentNode->setLocalName("Credentials");
+    * 
+    * 
     *  //create child node
+    * 
     *  BasicNode *childNode = phb->createChild(ELEMENT_NODE);
+    * 
     *  childNode->setLocalName("username");
+    * 
+    * 
     *  //create char node for value
+    * 
     *  BasicNode *valueNode = phb->createChild(CHARACTER_NODE);
+    * 
     *  valueNode->setValue("Test User");
+    * 
+    * 
     *  //buld node tree
+    * 
     *  childNode->addChild(valueNode);
+    * 
     *  parentNode->addChild(childNode);
     *
+    * 
     *  //add another node set
+    * 
     *  childNode = phb->createChild(ELEMENT_NODE);
+    * 
     *  childNode->setLocalName("password");
     *
     *  valueNode = phb->createChild(CHARACTER_NODE);
+    * 
     *  valueNode->setValue("Test Password");
     *
     *  childNode->addChild(valueNode);
+    * 
     *  parentNode->addChild(childNode);
     *
     *  phb->addChild(parentNode);
-    * </PRE>
+    * </code>
     *
     * @param pachLocalName Local tag name of the SOAP header. e.g. TestHeader    
     * @param pachUri Namespace URI to be used in SOAP header.
@@ -301,53 +323,78 @@
     * 
     * This will create a header block that would look like the following when 
     * serialized:
-    * <PRE>
-    *   <th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
-    *   </th:TestHeader>
-    * </PRE>
+    * \verbatim
+<th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
+</th:TestHeader>
+\endverbatim
     *
     * User must use the IHeaderBlock pointer returned and fill in the header structure.
     * e.g. To make the SOAP header look like
-    * <PRE>
-    * <SOAP-ENV:Header>
-    *   <th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
-    *       <Credentials>
-    *            <username>Test User</username>
-    *            <password>Test Password</password>
-    *       </Credentials>
-    *   </th:TestHeader>
-    * </SOAP-ENV:Header>
-    * </PRE>
-    * the following code segment coule be used
-    * <PRE>
-    *  IHeaderBlock *phb = ws.createSOAPHeaderBlock("TestHeader", 
+    * \verbatim
+<SOAP-ENV:Header>
+    <th:TestHeader xmlns:th="http://ws.apache.org/axisCppTest/">
+        <Credentials>
+            <username>Test User</username>
+            <password>Test Password</password>
+        </Credentials>
+    </th:TestHeader>
+</SOAP-ENV:Header>
+\endverbatim
+    * the following code segment could be used
+    * <code>
+    * 
+    * IHeaderBlock *phb = ws.createSOAPHeaderBlock("TestHeader", 
     *                                   "http://ws.apache.org/axisCppTest/",
     *                                   "th");
+    * 
+    * 
     *  //create parent node
+    * 
     *  BasicNode *parentNode = phb->createChild(ELEMENT_NODE);
+    * 
     *  parentNode->setLocalName("Credentials");
+    * 
+    * 
     *  //create child node
+    * 
     *  BasicNode *childNode = phb->createChild(ELEMENT_NODE);
+    * 
     *  childNode->setLocalName("username");
+    * 
+    * 
     *  //create char node for value
+    * 
     *  BasicNode *valueNode = phb->createChild(CHARACTER_NODE);
+    * 
     *  valueNode->setValue("Test User");
+    *
+    *  
     *  //buld node tree
+    * 
     *  childNode->addChild(valueNode);
+    * 
     *  parentNode->addChild(childNode);
+    * 
     *
     *  //add another node set
+    * 
     *  childNode = phb->createChild(ELEMENT_NODE);
+    * 
     *  childNode->setLocalName("password");
+    * 
     *
     *  valueNode = phb->createChild(CHARACTER_NODE);
+    * 
     *  valueNode->setValue("Test Password");
+    * 
     *
     *  childNode->addChild(valueNode);
+    * 
     *  parentNode->addChild(childNode);
+    * 
     *
     *  phb->addChild(parentNode);
-    * </PRE>
+    * </code>
     *
     * @param pachLocalName Local tag name of the SOAP header. e.g. TestHeader
     * @param pachPrefix Prefix to be used in XML represenation of SOAP header
@@ -560,6 +607,9 @@
     void setProxyAuthorizationHeader();
 
 
+    /**
+     * Call object
+     */
     Call *m_pCall;
 
   /**



Mime
View raw message