axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sam...@apache.org
Subject svn commit: r348146 - in /webservices/axis2/trunk/c: include/axis2_om_processing_instruction.h include/axis2_om_stax_builder.h include/axis2_om_text.h modules/xml/om/src/axis2_om_stax_builder.c
Date Tue, 22 Nov 2005 10:42:43 GMT
Author: samisa
Date: Tue Nov 22 02:42:16 2005
New Revision: 348146

URL: http://svn.apache.org/viewcvs?rev=348146&view=rev
Log:
doc comments added 

Modified:
    webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h
    webservices/axis2/trunk/c/include/axis2_om_stax_builder.h
    webservices/axis2/trunk/c/include/axis2_om_text.h
    webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_stax_builder.c

Modified: webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h?rev=348146&r1=348145&r2=348146&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h Tue Nov 22 02:42:16
2005
@@ -131,7 +131,7 @@
     * @param parent parent of the element node to be created. Optional, can be NULL.
     * @param target target of the processing instruction.cannot be NULL.
     * @param value value of the processing instruction.cannot be NULL.
-    * @param node This is an out parameter. Mandatory, cannot be NULL.
+    * @param node This is an out parameter. cannot be NULL.
     *                       Returns the node corresponding to the comment created.
     *                       Node type will be set to AXIS2_OM_PROCESSING_INSTRUCTION
     * @return a pointer tonewly created processing instruction struct 

Modified: webservices/axis2/trunk/c/include/axis2_om_stax_builder.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_stax_builder.h?rev=348146&r1=348145&r2=348146&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_stax_builder.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_stax_builder.h Tue Nov 22 02:42:16 2005
@@ -50,7 +50,7 @@
     {
       /**
         * Builds the next node from stream. Moves pull parser forward and reacts to events.
-        * @param environment Environment. MUST NOT be NULL, .
+        * @param environment Environment. MUST NOT be NULL.
         * @param builder pointer to stax builder struct to be used
         * @return a pointer to the next node, or NULL if there are no more nodes.
         *           On erros sets the error and returns NULL.
@@ -64,30 +64,44 @@
         * @param builder pointer to stax builder struct to be used
         * @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE.
         */
-        axis2_status_t (AXIS2_CALL *discard_current_element)(
-                           struct axis2_om_stax_builder *builder,axis2_env_t **env);
-
+        axis2_status_t (AXIS2_CALL *discard_current_element)
+                                    (struct axis2_om_stax_builder *builder,
+                                     axis2_env_t **env);
+        /**
+         * Free operation
+         * @param builder pointer to builder struct
+         * @param env environment, MUST NOT be NULL
+         * @return status of the operation AXIS2_SUCCESS on success,
+         *         AXIS2_FAILURE on error.
+         */
 			 
 		axis2_status_t (AXIS2_CALL *free)(struct axis2_om_stax_builder *builder,
 		                                  axis2_env_t **env);
+        
+       /** get the document associated with the builder  
+        * @param builder axis2_om_stax_builder 
+        * @param env environment 
+        * @return pointer to document struct associated with builder
+        *         NULL if there is no document associated with the builder,
+        *         NULL if an error occured.
+        */                                             
+        axis2_om_document_t* (AXIS2_CALL *get_document)
+                                         (struct axis2_om_stax_builder *builder,
+                                          axis2_env_t **env);
+        /**
+         *  set the document associated with the builder
+         * @param builder pointer to builder struct
+         * @param env environment , MUST NOT be NULL.
+         * @param document pointer to document struct that needs to be associated 
+         *                  with builder
+         * @return status of the operation. AXIS2_SUCCESS on success and AXIS2_FAILURE 
+         *                  on error.
+         */                                          
 
-
-        axis2_om_node_t* (AXIS2_CALL *get_lastnode)(struct axis2_om_stax_builder *builder,
-                                                    axis2_env_t **env);
-                                                    
-        axis2_om_document_t* (AXIS2_CALL *get_document)(struct axis2_om_stax_builder *builder,
-                                                    axis2_env_t **env);
-                                                    
-        axis2_status_t (AXIS2_CALL *set_lastnode)(struct axis2_om_stax_builder *builder,
-                                                  axis2_env_t **env,
-                                                  axis2_om_node_t *om_node);
-                                                    
         axis2_status_t  (AXIS2_CALL *set_document)(struct axis2_om_stax_builder *builder,
                                                    axis2_env_t **env,
                                                    axis2_om_document_t *document);      
                                             
                                                            
-
-
     } axis2_om_stax_builder_ops_t;
 
   /** 
@@ -117,19 +131,13 @@
 /** discards current node */
 #define AXIS2_OM_STAX_BUILDER_DISCARD(builder,env) \
         ((builder)->ops->discard_current_element(builder, env))
-/** free builder */
+/** free operation of the builder */
 #define AXIS2_OM_STAX_BUILDER_FREE(builder,env) \
         ((builder)->ops->free(builder,env))
-        
+/** associate a document with a builder */       
 #define AXIS2_OM_STAX_BUILDER_SET_DOCUMENT(builder,env,document) \
         ((builder)->ops->set_document(builder,env,document))
-
-#define AXIS2_OM_STAX_BUILDER_SET_LASTNODE(builder,env,lastnode) \
-        ((builder)->ops->set_lastnode(builder,env,lastnode))
-        
-#define AXIS2_OM_STAX_BUILDER_GET_LASTNODE(builder,env) \
-        ((builder)->ops->get_lastnode(builder,env)) 
-
+/** get the document associated with the builder */  
 #define AXIS2_OM_STAX_BUILDER_GET_DOCUMENT(builder,env) \
         ((builder)->ops->get_document(builder,env))
 	

Modified: webservices/axis2/trunk/c/include/axis2_om_text.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_text.h?rev=348146&r1=348145&r2=348146&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_text.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_text.h Tue Nov 22 02:42:16 2005
@@ -48,28 +48,42 @@
     {
       /**
         * Free an axis2_om_text struct
-        * @param environment environment.  MUST NOT be NULL, .
-        * @param om_text pointer to om text struct to be freed
-        * @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
+        * @param env environment.  MUST NOT be NULL.
+        * @param om_text pointer to om text struct to be freed.
+        * @return satus of the operation. AXIS2_SUCCESS on success
+        *         AXIS2_FAILURE on error.
         */
         axis2_status_t (AXIS2_CALL *free) (struct axis2_om_text *om_text,
                                            axis2_env_t **env);
 
       /**
         * Serialize operation
-        * @param environment environment.  MUST NOT be NULL, .
-        * @param om_text pointer to om text struct to be serialized
-        * @param om_output OM output handler to be used in serializing
-        * @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
+        * @param env environment.  MUST NOT be NULL.
+        * @param om_text pointer to om text struct to be serialized.
+        * @param om_output OM output handler to be used in serializing.
+        * @return satus of the operation. AXIS2_SUCCESS on success,
+        *            AXIS2_FAILURE on error
         */
         axis2_status_t (AXIS2_CALL *serialize) (struct axis2_om_text *om_text,
                                                 axis2_env_t **env,
                                                 axis2_om_output_t *om_output);
-                                                
+       /**
+        *  set the text value
+        * @param om_text om_text struct
+        * @param env environment , MUST NOT be NULL.
+        * @param value text 
+        * @return status of the operation. AXIS2_SUCCESS on success,
+        *           AXIS2_FAILURE on error.                                             
  
+        */                                                
         axis2_status_t (AXIS2_CALL *set_value)(struct axis2_om_text *om_text,
                                                axis2_env_t **env,
                                                const axis2_char_t *value);
-
+       /**
+        *  get text value 
+        * @param om_text om_text struct
+        * @param env environment, MUST NOT be NULL.
+        * @return text value , NULL is returned if there is no text value.
+        */                                                
         axis2_char_t* (AXIS2_CALL *get_value)(struct axis2_om_text *om_text,
                                               axis2_env_t **env);                       
                       
                                                
@@ -90,7 +104,7 @@
 
   /**
     * Creates a new text struct
-    * @param environment Environment. MUST  NOT be NULL, .
+    * @param env Environment. MUST  NOT be NULL, .
     * @param parent parent of the new node. Optinal, can be NULL. 
     *          The parent element must be of type AXIS2_OM_ELEMENT
     * @param value Text value. Optinal, can be NULL.
@@ -112,10 +126,10 @@
 /** serializes given text */
 #define AXIS2_OM_TEXT_SERIALIZE(om_text, env, om_output) \
         ((om_text)->ops->serialize(om_text, env, om_output))
-        
+/** get the text value */        
 #define AXIS2_OM_TEXT_GET_VALUE(om_text, env) \
         ((om_text)->ops->get_value(om_text, env))
-
+/** set text value */
 #define AXIS2_OM_TEXT_SET_VALUE(om_text, env, value) \
         ((om_text)->ops->set_value(om_text, env, value))
               

Modified: webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_stax_builder.c
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_stax_builder.c?rev=348146&r1=348145&r2=348146&view=diff
==============================================================================
--- webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_stax_builder.c (original)
+++ webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_stax_builder.c Tue Nov 22 02:42:16
2005
@@ -42,18 +42,11 @@
 axis2_om_stax_builder_free(axis2_om_stax_builder_t *builder,
                            axis2_env_t **env);
 
-axis2_om_node_t* AXIS2_CALL
-axis2_om_stax_builder_get_lastnode (axis2_om_stax_builder_t *builder,
-                                   axis2_env_t **env);
                                             
 axis2_om_document_t* AXIS2_CALL
 axis2_om_stax_builder_get_document (axis2_om_stax_builder_t *builder,
                                     axis2_env_t **env);
                                             
-axis2_status_t AXIS2_CALL
-axis2_om_stax_builder_set_lastnode(axis2_om_stax_builder_t *builder,
-                                    axis2_env_t **env,
-                                    axis2_om_node_t *om_node);
                                             
 axis2_status_t  AXIS2_CALL
 axis2_om_stax_builder_set_document(axis2_om_stax_builder_t *builder,
@@ -134,8 +127,6 @@
         
 	builder->om_stax_builder.ops->free = axis2_om_stax_builder_free;
 	builder->om_stax_builder.ops->set_document = axis2_om_stax_builder_set_document;
-	builder->om_stax_builder.ops->set_lastnode = axis2_om_stax_builder_set_lastnode;
-	builder->om_stax_builder.ops->get_lastnode = axis2_om_stax_builder_get_lastnode;
 	
     return &(builder->om_stax_builder);
 }
@@ -721,14 +712,6 @@
 	return AXIS2_SUCCESS;	
 	
 }
-
-axis2_om_node_t* AXIS2_CALL
-axis2_om_stax_builder_get_lastnode (axis2_om_stax_builder_t *builder,
-                                   axis2_env_t **env)
-{
-    AXIS2_FUNC_PARAM_CHECK(builder, env, NULL);
-    return AXIS2_INTF_TO_IMPL(builder)->lastnode;
-}                                   
                                             
 axis2_om_document_t* AXIS2_CALL
 axis2_om_stax_builder_get_document (axis2_om_stax_builder_t *builder,
@@ -739,16 +722,6 @@
 }
                                     
                                             
-axis2_status_t AXIS2_CALL
-axis2_om_stax_builder_set_lastnode(axis2_om_stax_builder_t *builder,
-                                    axis2_env_t **env,
-                                    axis2_om_node_t *om_node)
-{
-    AXIS2_FUNC_PARAM_CHECK(builder,env,AXIS2_FAILURE);
-    AXIS2_PARAM_CHECK((*env)->error, om_node, AXIS2_FAILURE);
-    AXIS2_INTF_TO_IMPL(builder)->lastnode = om_node ;
-    return AXIS2_SUCCESS;
-}                                    
                                             
 axis2_status_t  AXIS2_CALL
 axis2_om_stax_builder_set_document(axis2_om_stax_builder_t *builder,



Mime
View raw message