axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kausha...@apache.org
Subject svn commit: r642129 - in /webservices/axis2/trunk/c/axiom/include: axiom_processing_instruction.h axiom_soap_body.h axiom_soap_builder.h
Date Fri, 28 Mar 2008 08:22:59 GMT
Author: kaushalye
Date: Fri Mar 28 01:22:58 2008
New Revision: 642129

URL: http://svn.apache.org/viewvc?rev=642129&view=rev
Log:
hackathon : Axiom headers

Modified:
    webservices/axis2/trunk/c/axiom/include/axiom_processing_instruction.h
    webservices/axis2/trunk/c/axiom/include/axiom_soap_body.h
    webservices/axis2/trunk/c/axiom/include/axiom_soap_builder.h

Modified: webservices/axis2/trunk/c/axiom/include/axiom_processing_instruction.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_processing_instruction.h?rev=642129&r1=642128&r2=642129&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_processing_instruction.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_processing_instruction.h Fri Mar 28 01:22:58
2008
@@ -48,7 +48,6 @@
       * @return a pointer tonewly created processing instruction struct 
       */
     AXIS2_EXTERN axiom_processing_instruction_t *AXIS2_CALL
-
     axiom_processing_instruction_create(
         const axutil_env_t * env,
         axiom_node_t * parent,
@@ -70,11 +69,10 @@
     /**
      * Set processing instruction data
      * @param om_pi
-     * @param env    
+     * @param env Environment. MUST NOT be NULL, .
      * @param value 
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_processing_instruction_set_value(
         struct axiom_processing_instruction *om_pi,
         const axutil_env_t * env,
@@ -89,7 +87,6 @@
      *     AXIS2_FAILURE on error.
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_processing_instruction_set_target(
         struct axiom_processing_instruction *om_pi,
         const axutil_env_t * env,
@@ -98,11 +95,10 @@
     /**
      * Get PI target
      * @param om_pi processing_instruction struct
-     * @param env environment 
+     * @param env Environment. MUST NOT be NULL, .
      * @return target text , NULL on error or if target is null
      */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
     axiom_processing_instruction_get_target(
         struct axiom_processing_instruction *om_pi,
         const axutil_env_t * env);
@@ -114,7 +110,6 @@
      * @return data text , NULL if there is no data,
      */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
-
     axiom_processing_instruction_get_value(
         struct axiom_processing_instruction *om_pi,
         const axutil_env_t * env);
@@ -128,7 +123,6 @@
      *     AXIS2_FAILURE on error 
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_processing_instruction_serialize(
         struct axiom_processing_instruction *om_pi,
         const axutil_env_t * env,

Modified: webservices/axis2/trunk/c/axiom/include/axiom_soap_body.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_soap_body.h?rev=642129&r1=642128&r2=642129&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_soap_body.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_soap_body.h Fri Mar 28 01:22:58 2008
@@ -58,10 +58,11 @@
     /**
       * creates a soap body struct 
       * @param env Environment. MUST NOT be NULL
+      * @param envelope the SOAP envelope to set the SOAP Body
+      * @return created SOAP Body
       */
 
     AXIS2_EXTERN axiom_soap_body_t *AXIS2_CALL
-
     axiom_soap_body_create_with_parent(
         const axutil_env_t * env,
         struct axiom_soap_envelope *envelope);
@@ -127,7 +128,9 @@
 
     /**
      * build the soap body completely . return the status code,
-    * @return AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+     * @param body pointer to soap_body struct
+     * @param env axutil_environment struct MUST not be NULL
+     * @returns status code , AXIS2_SUCCESS on success , AXIS2_ERROR
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_soap_body_build(
@@ -152,9 +155,11 @@
     * SOAP builder construct a SOAP 1.2 fault all the time. 
     * So when SOAP 1.1 is in use, we should convert SOAP fault to 
     * SOAP 1.1 fault format before use.
+     * @param body pointer to soap_body struct
+     * @param env axutil_environment struct MUST not be NULL
+     * @returns status code , AXIS2_SUCCESS on success , AXIS2_ERROR
     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_soap_body_convert_fault_to_soap11(
         axiom_soap_body_t * soap_body,
         const axutil_env_t * env);

Modified: webservices/axis2/trunk/c/axiom/include/axiom_soap_builder.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_soap_builder.h?rev=642129&r1=642128&r2=642129&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_soap_builder.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_soap_builder.h Fri Mar 28 01:22:58 2008
@@ -43,76 +43,146 @@
     /**
      * creates a axiom_soap_builder struct
      * @param env Environment. MUST NOT be NULL
+     * @param builder Stax builder
+     * @return the created SOAP Builder
      */
     AXIS2_EXTERN axiom_soap_builder_t *AXIS2_CALL
     axiom_soap_builder_create(
         const axutil_env_t * env,
         axiom_stax_builder_t * builder,
         const axis2_char_t * soap_version);
-
+    /**
+     * Free the SOAP Builder
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return VOID
+     */
     AXIS2_EXTERN void AXIS2_CALL
     axiom_soap_builder_free(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     * Get the SOAP envelope of the SOAP builder
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return the SOAP envelope
+     */
     AXIS2_EXTERN axiom_soap_envelope_t *AXIS2_CALL
-
     axiom_soap_builder_get_soap_envelope(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     * Get the OM document of the SOAP Buidler
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return the OM document
+     */
     AXIS2_EXTERN axiom_document_t *AXIS2_CALL
-
     axiom_soap_builder_get_document(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return AXIS2_SUCCESS if the next element is present else AXIS2_FAILURE
+     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_soap_builder_next(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return the axiom_node of the OM document
+     */
     AXIS2_EXTERN axiom_node_t *AXIS2_CALL
-
     axiom_soap_builder_get_document_element(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
+     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_soap_builder_set_bool_processing_mandatory_fault_elements(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env,
         axis2_bool_t value);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
+     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_soap_builder_set_processing_detail_elements(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env,
         axis2_bool_t value);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return AXIS2_TRUE if the the element is present, AXIS2_FALSE otherwise
+     */
     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
-
     axiom_soap_builder_is_processing_detail_elements(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return the SOAP version
+     */
     AXIS2_EXTERN int AXIS2_CALL
     axiom_soap_builder_get_soap_version(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env);
 
+    /**
+     *
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
+     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_soap_builder_process_namespace_data(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env,
         axiom_node_t * om_node,
         axis2_bool_t is_soap_element);
 
+    /**
+     * Set the MIME body parts
+     * @param builder pointer to the SOAP Builder struct
+     * @param env Environment. MUST NOT be NULL
+     *
+     * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
+     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_soap_builder_set_mime_body_parts(
         axiom_soap_builder_t * builder,
         const axutil_env_t * env,



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


Mime
View raw message