You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by sa...@apache.org on 2005/11/22 10:26:57 UTC
svn commit: r348134 - in /webservices/axis2/trunk/c/include:
axis2_om_output.h axis2_om_processing_instruction.h
Author: samisa
Date: Tue Nov 22 01:26:48 2005
New Revision: 348134
URL: http://svn.apache.org/viewcvs?rev=348134&view=rev
Log:
doc comments added
Modified:
webservices/axis2/trunk/c/include/axis2_om_output.h
webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h
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=348134&r1=348133&r2=348134&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_output.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_output.h Tue Nov 22 01:26:48 2005
@@ -48,7 +48,8 @@
*/
typedef struct axis2_om_output
{
- /** xml stream writer. Should implement the Guththila pull parser interface */
+ /** axis2_xml_writer. any xml writer which
+ implemet axis2_xml_writer.h interface */
axis2_xml_writer_t *xml_writer;
/* following fields are not used currently but will be used in the future */
@@ -93,8 +94,6 @@
*@param env environment
*@return status code AXIS2_SUCCESS on success, AXIS2_FAILURE otherwise
*/
-
-
AXIS2_DECLARE(axis2_status_t)
axis2_om_output_free(axis2_om_output_t *om_output,
axis2_env_t **env);
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=348134&r1=348133&r2=348134&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 01:26:48 2005
@@ -69,9 +69,11 @@
const axis2_char_t* value);
/**
* set processing instruction target
- *@param om_pi
- *@param env
- *@param target
+ *@param om_pi processing_instruction struct
+ *@param env environment, MUST NOT be NULL.
+ *@param target
+ *@return status of the operation AXIS2_SUCCESS on success,
+ * AXIS2_FAILURE on error.
*/
axis2_status_t (AXIS2_CALL *set_target)
@@ -80,19 +82,30 @@
const axis2_char_t* target);
/**
* get PI target
+ * @param om_pi processing_instruction struct
+ * @param env environment
+ * @return target text , NULL on error or if target is null
*/
axis2_char_t* (AXIS2_CALL *get_target)
(struct axis2_om_processing_instruction *om_pi,
axis2_env_t **env);
/**
- * get PI value
+ * get data part of processing_instruction
+ * @param om_pi processing instruction
+ * @param env environment , MUST NOT be NULL.
+ * @return data text , NULL if there is no data,
*/
axis2_char_t* (AXIS2_CALL *get_value)
(struct axis2_om_processing_instruction *om_pi,
axis2_env_t **env);
/**
- * serialize function
+ * serialize function
+ * @param om_pi processing_instruction struct
+ * @param env environment, MUST NOT be NULL.
+ * @param om_output om_output handler struct
+ * @return status of the operation, AXIS2_SUCCESS on success,
+ * AXIS2_FAILURE on error
*/
axis2_status_t (AXIS2_CALL *serialize)
(struct axis2_om_processing_instruction *om_pi,
@@ -114,13 +127,13 @@
/**
* Creates a processing instruction
- * @param environment Environment. MUST NOT be NULL, .
+ * @param environment Environment. MUST NOT be NULL.
* @param parent parent of the element node to be created. Optional, can be NULL.
- * @param target target of the processing instruction. Mandatory, cannot be NULL.
- * @param value value of the processing instruction. Mandatory, cannot 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.
* Returns the node corresponding to the comment created.
- * Node type will be set to AXIS2_OM_ELEMENT
+ * Node type will be set to AXIS2_OM_PROCESSING_INSTRUCTION
* @return a pointer tonewly created processing instruction struct
*/
AXIS2_DECLARE(axis2_om_processing_instruction_t *)
@@ -130,23 +143,23 @@
const axis2_char_t * value,
axis2_om_node_t ** node);
+
/** frees given processing instruction */
#define AXIS2_OM_PROCESSING_INSTRUCTION_FREE(pi, env) \
((pi)->ops->free(pi, env))
-
+/** set data text of processing_instruction */
#define AXIS2_OM_PROCESSING_INSTRUCION_SET_VALUE(pi, env, value) \
((pi)->ops->set_value(pi,env,value))
-
+/** get data text of processing_instruction */
#define AXIS2_OM_PROCESSING_INSTRUCTION_GET_VALUE(pi, env) \
((pi)->ops->get_value(pi, env))
-
+/** set target of processing instruction */
#define AXIS2_OM_PROCESSING_INSTRUCION_SET_TARGET(pi, env, value) \
((pi)->ops->set_target(pi, env, value))
-
+/** get target text */
#define AXIS2_OM_PROCESSING_INSTRUCTION_GET_TARGET(pi, env) \
((pi)->ops->get_target(pi, env))
-
-
+/** serialize */
#define AXIS2_OM_PROCESSING_INSTRUCTION_SERIALIZE(pi, env, om_output) \
((pi)->ops->serialize(pi, env, om_output))