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 sa...@apache.org on 2005/10/24 06:45:05 UTC

svn commit: r327964 - in /webservices/axis2/trunk/c: include/axis2_om_output.h modules/xml/om/src/axis2_om_node.c modules/xml/om/src/axis2_om_output.c

Author: samisa
Date: Sun Oct 23 21:44:54 2005
New Revision: 327964

URL: http://svn.apache.org/viewcvs?rev=327964&view=rev
Log:
Fixed doc comments and also switch statements in source files

Modified:
    webservices/axis2/trunk/c/include/axis2_om_output.h
    webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_node.c
    webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_output.c

Modified: webservices/axis2/trunk/c/include/axis2_om_output.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_output.h?rev=327964&r1=327963&r2=327964&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_output.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_output.h Sun Oct 23 21:44:54 2005
@@ -40,17 +40,16 @@
     static const char *DEFAULT_CHAR_SET_ENCODING = "utf-8";
 
 
-/** 
-    \brief OM Output struct
-
-    The XML writer interface struct of om
-*/
-
+  /** 
+    * \brief OM Output struct
+    * The XML writer interface struct of om
+    */
     typedef struct axis2_om_output
     {
-        /* The xml writer */
+        /** xml stream writer. Should implement the Guththila pull parser interface */
         void *xml_writer;
 
+        /* following fields are not used currently but will be used in the future */
         axis2_bool_t do_optimize;
         axis2_char_t *mime_boundary;
         axis2_char_t *root_content_id;
@@ -59,29 +58,29 @@
         axis2_char_t *char_set_encoding;
         /* xml version */
         axis2_char_t *xml_version;
-
         axis2_bool_t ignore_xml_declaration;
     } axis2_om_output_t;
-/**
- * creates output struct and returns a pointer to newly created struct
- * @param environment Environment .MUST NOT be NULL, if NULL behaviour is undefined.
- * @param xml_writer XML_WRITER . IF null default xml writer(guththila writer ) will be created 
- *   with stdout as the output stream
- * @return om_output_t 
- */
+    
+  /**
+    * creates OM output struct 
+    * @param environment Environment. MUST NOT be NULL, if NULL behaviour is undefined.
+    * @param xml_writer XML writer. Optional, can be NULL. If NULL default xml writer
+    *           (guththila writer ) will be created with stdout as the output stream
+    * @return a pointer to newly created output struct.
+    */
 
     axis2_om_output_t *axis2_create_om_output (axis2_environment_t *
                                                environment, void *xml_writer);
 
-/**
- *  Performs xml writing .
- *  Accepts variable number of args depending on the on type 
- *  @param environment Environment .MUST NOT be NULL, if NULL behaviour is undefined.
- *  @param om_output OM OUTPUT 
- *  @param type Type is one of the om_types e.g AXIS2_OM_ELEMENT
- *  @param no_of_args Number of arguments passed.
- *  @returns status code 
- */
+  /**
+    *  Performs xml writing.
+    *  Accepts variable number of args depending on the on OM type to be serialized
+    *  @param environment Environment. MUST NOT be NULL, if NULL behaviour is undefined.
+    *  @param om_output Output struct to be used 
+    *  @param type one of the OM types
+    *  @param no_of_args number of arguments passed in the variable parameter list
+    *  @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
+    */
 
     axis2_status_t axis2_om_output_write (axis2_environment_t * environment,
                                           axis2_om_output_t * om_output,

Modified: webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_node.c
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_node.c?rev=327964&r1=327963&r2=327964&view=diff
==============================================================================
--- webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_node.c (original)
+++ webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_node.c Sun Oct 23 21:44:54 2005
@@ -377,19 +377,8 @@
                                      data_element, om_output);
         return status;
         break;
-    case AXIS2_OM_INVALID:
-        break;
-    case AXIS2_OM_DOCUMENT:
-        break;
-    case AXIS2_OM_DOCTYPE:
-        break;
-    case AXIS2_OM_COMMENT:
-        break;
-    case AXIS2_OM_ATTRIBUTE:
-        break;
-    case AXIS2_OM_NAMESPACE:
-        break;
-    case AXIS2_OM_PROCESSING_INSTRUCTION:
+    
+    default:
         break;
     }
 
@@ -415,21 +404,8 @@
         if (status != AXIS2_SUCCESS)
             return status;
         break;
-    case AXIS2_OM_TEXT:
-        break;
-    case AXIS2_OM_INVALID:
-        break;
-    case AXIS2_OM_DOCUMENT:
-        break;
-    case AXIS2_OM_DOCTYPE:
-        break;
-    case AXIS2_OM_COMMENT:
-        break;
-    case AXIS2_OM_ATTRIBUTE:
-        break;
-    case AXIS2_OM_NAMESPACE:
-        break;
-    case AXIS2_OM_PROCESSING_INSTRUCTION:
+    
+    default:
         break;
     }
 

Modified: webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_output.c
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_output.c?rev=327964&r1=327963&r2=327964&view=diff
==============================================================================
--- webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_output.c (original)
+++ webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_output.c Sun Oct 23 21:44:54 2005
@@ -140,14 +140,7 @@
                                                           xml_writer,
                                                           args_list[0]);
         break;
-    case AXIS2_OM_DOCUMENT:
-        break;
-    case AXIS2_OM_DOCTYPE:
-        break;
-    case AXIS2_OM_COMMENT:
-        break;
-    case AXIS2_OM_PROCESSING_INSTRUCTION:
-        break;
+    
     default:
         break;
     };