axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kausha...@apache.org
Subject svn commit: r642111 - in /webservices/axis2/trunk/c/axiom/include: axiom_element.h axiom_node.h axiom_output.h
Date Fri, 28 Mar 2008 07:25:10 GMT
Author: kaushalye
Date: Fri Mar 28 00:24:49 2008
New Revision: 642111

URL: http://svn.apache.org/viewvc?rev=642111&view=rev
Log:
Hackathon : header comments

Modified:
    webservices/axis2/trunk/c/axiom/include/axiom_element.h
    webservices/axis2/trunk/c/axiom/include/axiom_node.h
    webservices/axis2/trunk/c/axiom/include/axiom_output.h

Modified: webservices/axis2/trunk/c/axiom/include/axiom_element.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_element.h?rev=642111&r1=642110&r2=642111&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_element.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_element.h Fri Mar 28 00:24:49 2008
@@ -126,7 +126,6 @@
      *
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_element_declare_namespace_assume_param_ownership(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -143,7 +142,6 @@
      *           NULL and sets the error code in environment's error struct.
      */
     AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
-
     axiom_element_find_namespace_with_qname(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -212,7 +210,6 @@
       * @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
       */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_element_serialize_start_part(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -376,7 +373,6 @@
      *
      */
     AXIS2_EXTERN axiom_children_iterator_t *AXIS2_CALL
-
     axiom_element_get_children(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -393,7 +389,6 @@
      */
 
     AXIS2_EXTERN axiom_children_qname_iterator_t *AXIS2_CALL
-
     axiom_element_get_children_with_qname(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -412,7 +407,6 @@
      */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
-
     axiom_element_get_first_child_with_qname(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -504,7 +498,6 @@
      * @returns axiom_child_element_iterator_t , NULL on error    
      */
     AXIS2_EXTERN axiom_child_element_iterator_t *AXIS2_CALL
-
     axiom_element_get_child_elements(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -535,7 +528,6 @@
      * @returns pointer to default namespace if availale , NULL otherwise
      */
     AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
-
     axiom_element_get_default_namespace(
         axiom_element_t * om_element,
         const axutil_env_t * env,
@@ -549,7 +541,6 @@
      * @returns the declared namespace
                                                  */
     AXIS2_EXTERN axiom_namespace_t *AXIS2_CALL
-
     axiom_element_declare_default_namespace(
         axiom_element_t * om_element,
         const axutil_env_t * env,

Modified: webservices/axis2/trunk/c/axiom/include/axiom_node.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_node.h?rev=642111&r1=642110&r2=642111&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_node.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_node.h Fri Mar 28 00:24:49 2008
@@ -295,23 +295,47 @@
      * returns null if no document is available
      * @param om_node 
      * @param env environment, MUST NOT be NULL.
+     *
+     * @return the OM document of the node
      */
     AXIS2_EXTERN struct axiom_document *AXIS2_CALL
                 axiom_node_get_document(
                     axiom_node_t * om_node,
                     const axutil_env_t * env);
 
+    /**
+     *
+     * @param om_node pointer to the OM node struct
+     * @param env environment, MUST NOT be NULL
+     *
+     * @return the string representation of the node
+     */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_node_to_string(
         axiom_node_t * om_node,
         const axutil_env_t * env);
 
+    /**
+     *
+     * @param om_node pointer to the OM node struct
+     * @param env environment, MUST NOT be NULL
+     * @param om_output the serialized output will be placed here
+     *
+     * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
+     */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_node_serialize_sub_tree(
         axiom_node_t * om_node,
         const axutil_env_t * env,
         struct axiom_output *om_output);
 
+    /**
+     *
+     * @param om_node pointer to the OM node struct
+     * @param env environment, MUST NOT be NULL
+     *
+     * @return the tree as a string
+     */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_node_sub_tree_to_string(
         axiom_node_t * om_node,
@@ -320,6 +344,10 @@
     /**
      * Convert the node to string, treating the binary contents, if any, 
      * as non-optimized content.
+     * @param om_node pointer to the OM node struct
+     * @param env environment, MUST NOT be NULL
+     *
+     * @return the none optimized string 
      */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_node_to_string_non_optimized(

Modified: webservices/axis2/trunk/c/axiom/include/axiom_output.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_output.h?rev=642111&r1=642110&r2=642111&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_output.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_output.h Fri Mar 28 00:24:49 2008
@@ -150,7 +150,6 @@
      * Sets the char set encoding property
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_output_set_char_set_encoding(
         axiom_output_t * om_output,
         const axutil_env_t * env,
@@ -189,7 +188,6 @@
      *  @returns content id
      */
     AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
-
     axiom_output_get_content_type(
         axiom_output_t * om_output,
         const axutil_env_t * env);
@@ -198,7 +196,6 @@
      * Writes the xml versio encoding 
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_output_write_xml_version_encoding(
         axiom_output_t * om_output,
         const axutil_env_t * env);
@@ -226,12 +223,16 @@
     axiom_output_get_root_content_id(
         axiom_output_t * om_output,
         const axutil_env_t * env);
-
+    /**
+     *
+     */
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_output_get_mime_boundry(
         axiom_output_t * om_output,
         const axutil_env_t * env);
-
+    /**
+     *
+     */
     AXIS2_EXTERN axis2_byte_t *AXIS2_CALL
     axiom_output_flush(
         axiom_output_t * om_output,



---------------------------------------------------------------------
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