You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ka...@apache.org on 2008/03/30 13:30:06 UTC

svn commit: r642714 - in /webservices/axis2/trunk/c/axiom/include: axiom_soap_fault_text.h axiom_soap_fault_value.h

Author: kaushalye
Date: Sun Mar 30 04:30:05 2008
New Revision: 642714

URL: http://svn.apache.org/viewvc?rev=642714&view=rev
Log:
Hackathon : SOAP headers

Modified:
    webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_text.h
    webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_value.h

Modified: webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_text.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_text.h?rev=642714&r1=642713&r2=642714&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_text.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_text.h Sun Mar 30 04:30:05 2008
@@ -40,11 +40,13 @@
      */
 
     /**
-      * creates a soap struct 
+      * creates a soap fault struct 
       * @param env Environment. MUST NOT be NULL
+      * @param fault the SOAP fault reason
+      *
+      * @return Created SOAP fault text
       */
     AXIS2_EXTERN axiom_soap_fault_text_t *AXIS2_CALL
-
     axiom_soap_fault_text_create_with_parent(
         const axutil_env_t * env,
         axiom_soap_fault_reason_t * fault);
@@ -56,29 +58,58 @@
       * @return satus of the op. AXIS2_SUCCESS on success 
       *         else AXIS2_FAILURE
       */
-
     AXIS2_EXTERN void AXIS2_CALL
     axiom_soap_fault_text_free(
         axiom_soap_fault_text_t * fault_text,
         const axutil_env_t * env);
 
+    /**
+      * Set the lang of the SOAP fault text
+      * @param  fault_text pointer to soap_fault_text struct
+      * @param  env Environment. MUST NOT be NULL
+      * @param lang the string to be set
+      * @return satus of the op. AXIS2_SUCCESS on success 
+      *         else AXIS2_FAILURE
+      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_soap_fault_text_set_lang(
         axiom_soap_fault_text_t * fault_text,
         const axutil_env_t * env,
         const axis2_char_t * lang);
 
+    /**
+      * Get the lang of the SOAP fault
+      * @param  fault_text pointer to soap_fault_text struct
+      * @param  env Environment. MUST NOT be NULL
+      * 
+      * @return the lang of the SOAP fault 
+      */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_soap_fault_text_get_lang(
         axiom_soap_fault_text_t * fault_text,
         const axutil_env_t * env);
 
+    /**
+      * Get the base node of the SOAP fault text
+      * @param  fault_text pointer to soap_fault_text struct
+      * @param  env Environment. MUST NOT be NULL
+      * 
+      * @return the base node of the SOAP fault text 
+      */
     AXIS2_EXTERN axiom_node_t *AXIS2_CALL
-
     axiom_soap_fault_text_get_base_node(
         axiom_soap_fault_text_t * fault_text,
         const axutil_env_t * env);
 
+    /**
+      * Set the SOAP fault text 
+      * @param  fault_text pointer to soap_fault_text struct
+      * @param  env Environment. MUST NOT be NULL
+      * @param value the text value
+      * @param lang string to be compared
+      * @return satus of the op. AXIS2_SUCCESS on success 
+      *         else AXIS2_FAILURE
+      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_soap_fault_text_set_text(
         axiom_soap_fault_text_t * fault_text,
@@ -86,6 +117,13 @@
         axis2_char_t * value,
         axis2_char_t * lang);
 
+    /**
+      * get the SOAP fault text 
+      * @param  fault_text pointer to soap_fault_text struct
+      * @param  env Environment. MUST NOT be NULL
+      * 
+      * @return the Text of the SOAP fault 
+      */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_soap_fault_text_get_text(
         axiom_soap_fault_text_t * fault_text,

Modified: webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_value.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_value.h?rev=642714&r1=642713&r2=642714&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_value.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_soap_fault_value.h Sun Mar 30 04:30:05 2008
@@ -45,13 +45,18 @@
       * @param env Environment. MUST NOT be NULL
       */
     AXIS2_EXTERN axiom_soap_fault_value_t *AXIS2_CALL
-
     axiom_soap_fault_value_create_with_subcode(
         const axutil_env_t * env,
         axiom_soap_fault_sub_code_t * parent);
 
+    /**
+      * Create s SOAP fault value givn a SOAP fault code 
+      * @param  fault_value pointer to soap_fault_value struct
+      * @param  env Environment. MUST NOT be NULL
+      *
+      * @return Created SOAP fault value 
+      */
     AXIS2_EXTERN axiom_soap_fault_value_t *AXIS2_CALL
-
     axiom_soap_fault_value_create_with_code(
         const axutil_env_t * env,
         axiom_soap_fault_code_t * parent);
@@ -60,10 +65,9 @@
       * Free an axiom_soap_fault_value
       * @param  fault_value pointer to soap_fault_value struct
       * @param  env Environment. MUST NOT be NULL
-      * @return satus of the op. AXIS2_SUCCESS on success 
-      *         else AXIS2_FAILURE
+      *
+      * @return VOID 
       */
-
     AXIS2_EXTERN void AXIS2_CALL
     axiom_soap_fault_value_free(
         axiom_soap_fault_value_t * fault_value,
@@ -85,9 +89,10 @@
       * @param fault_value pointer to axiom_soap_fault_t
       * @param env Environment. MUST NOT BE NULL
       * @param text value to be set
+      *
+      * @return the base node
       */
     AXIS2_EXTERN axiom_node_t *AXIS2_CALL
-
     axiom_soap_fault_value_get_base_node(
         axiom_soap_fault_value_t * fault_value,
         const axutil_env_t * env);
@@ -97,8 +102,9 @@
      * @param fault_value pointer to soap fault value struct
      * @param env environment MUST not be NULL
      * @param text Text value to be set
+     * @return satus of the op. AXIS2_SUCCESS on success 
+     *         else AXIS2_FAILURE
      */
-
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_soap_fault_value_set_text(
         axiom_soap_fault_value_t * fault_value,



---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org