axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lah...@apache.org
Subject svn commit: r643338 - /webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h
Date Tue, 01 Apr 2008 09:39:09 GMT
Author: lahiru
Date: Tue Apr  1 02:39:06 2008
New Revision: 643338

URL: http://svn.apache.org/viewvc?rev=643338&view=rev
Log:
added documentation of methods in to this file

Modified:
    webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h

Modified: webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h?rev=643338&r1=643337&r2=643338&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_xml_writer.h Tue Apr  1 02:39:06 2008
@@ -542,8 +542,13 @@
     };
 
     /**
-     *  create function for axiom_xml_writer
-     *
+     * create function for axiom_xml_writer
+     * @param env environment
+     * @param filename filename 
+     * @param encoding encoding
+     * @param is_prefix_default 
+     * @param compression
+     * return xml writer wrapper structure 
      */
     AXIS2_EXTERN axiom_xml_writer_t *AXIS2_CALL
     axiom_xml_writer_create(
@@ -554,9 +559,13 @@
         int compression);
 
     /**
+     * create fuction for xml writer for memory buffer
      * @param env environment struct, must not be null
-     *
-     * @return 
+     * @param env environment
+     * @param encoding encoding
+     * @param is_prefix_default
+     * @param compression 
+     * @return xml writer wrapper structure.
      */
     AXIS2_EXTERN axiom_xml_writer_t *AXIS2_CALL
     axiom_xml_writer_create_for_memory(
@@ -567,9 +576,10 @@
         int type);
 
     /**
+     * free method for axiom xml writer
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * 
      * @return 
      */
     AXIS2_EXTERN void AXIS2_CALL
@@ -580,11 +590,10 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the start element
      * @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axiom_xml_writer_write_start_element(
         axiom_xml_writer_t * writer,
         const axutil_env_t * env,
@@ -617,8 +626,10 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
-     * @return 
+     * @param localname localname of the start element
+     * @param namespace_uri namespace uri of that element
+     * @param prefix prefix of that namespace
+     * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_xml_writer_write_start_element_with_namespace_prefix(
@@ -631,7 +642,7 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the element
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -643,7 +654,8 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the element
+     * @param namespace_uri uri of the namespace
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -656,7 +668,9 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the element
+     * @param namespace_uri uri of the namespace
+     * @param prefix prefix of the namespace
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -670,7 +684,7 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * 
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -692,7 +706,8 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the element
+     * @param value value of the element 
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -705,7 +720,9 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the element
+     * @param value value of the element
+     * @param uri of the namespace
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -719,7 +736,10 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param localname local name of the element
+     * @param value value of the element
+     * @param uri of the namespace
+     * @param prefix of the namespace
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -734,7 +754,8 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * @param prefix prefix of the namespace
+     * @param uri of the namespace
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -747,7 +768,7 @@
     /**
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
-     *
+     * 
      * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -893,7 +914,7 @@
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
      *
-     * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+     * @return prefix 
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_xml_writer_set_prefix(
@@ -915,6 +936,7 @@
         axis2_char_t * uri);
 
     /**
+     * sets the default prefix
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
      *
@@ -953,7 +975,7 @@
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
      *
-     * @return 
+     * @return size of the xml
      */
     AXIS2_EXTERN int AXIS2_CALL
     axiom_xml_writer_get_type(
@@ -964,7 +986,7 @@
      * @param writer pointer to the OM XML Writer struct
      * @param env environment struct, must not be null
      *
-     * @return status of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE
+     * @return type 
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axiom_xml_writer_write_raw(



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