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:57:36 UTC
svn commit: r327969 - in /webservices/axis2/trunk/c:
include/axis2_om_processing_instruction.h
modules/xml/om/src/axis2_om_processing_instruction.c
Author: samisa
Date: Sun Oct 23 21:57:20 2005
New Revision: 327969
URL: http://svn.apache.org/viewcvs?rev=327969&view=rev
Log:
Added doc comments
Modified:
webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h
webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_processing_instruction.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=327969&r1=327968&r2=327969&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_processing_instruction.h Sun Oct 23 21:57:20 2005
@@ -40,57 +40,57 @@
*/
-/**
- @brief OM text operations struct
-
- Encapsulator struct for operations of axis2_om_processing_instruction
-*/
+ /**
+ * @brief OM text operations struct
+ * Encapsulator struct for operations of axis2_om_processing_instruction
+ */
typedef struct axis2_om_processing_instruction_ops
{
- /**
- * Free an instance of axis2_om_processing_instruction
- * @param environment Environment .MUST NOT be NULL, if NULL behaviour is undefined.
- * @param om_pi
- * @returns Status code
- */
- axis2_status_t (*axis2_om_processing_instruction_ops_free)
+ /**
+ * Frees an instance of axis2_om_processing_instruction
+ * @param environment Environment. MUST NOT be NULL, if NULL behaviour is undefined.
+ * @param om_pi processing instruction to be freed.
+ * @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
+ */
+ AXIS2_DECLARE_DATA axis2_status_t (AXIS2_CALL *axis2_om_processing_instruction_ops_free)
(axis2_environment_t * environment,
struct axis2_om_processing_instruction * om_pi);
} axis2_om_processing_instruction_ops_t;
-/**
- \brief OM processing_instruction
-
- Handles the XML processing instructions in OM
-*/
+ /**
+ * \brief OM processing instruction
+ * Handles the XML processing instructions in OM
+ */
typedef struct axis2_om_processing_instruction
{
- /** operations struct */
+ /** operations struct */
axis2_om_processing_instruction_ops_t *ops;
- /* PI target */
+ /** processing instruction target */
axis2_char_t *target;
- /** PI value */
+ /** processing instruction value */
axis2_char_t *value;
} axis2_om_processing_instruction_t;
-/**
- * creates axis2_om_processing_instruction
- * @param environment Environment .MUST NOT be NULL, if NULL behaviour is undefined.
- * @param target
- * @param value
- * @parent parent node
- * @param node This is an outparameter , the created struct will be set as node's data_element
- * @return a pointer to axis2_om_processing_instruction_t struct
- */
-
- axis2_om_processing_instruction_t
- *axis2_om_processing_instruction_create (axis2_environment_t *
+ /**
+ * Creates a processing instruction
+ * @param environment Environment. MUST NOT be NULL, if NULL behaviour is undefined.
+ * @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 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
+ * @return a pointer tonewly created processing instruction struct
+ */
+ AXIS2_DECLARE(axis2_om_processing_instruction_t *)
+ axis2_om_processing_instruction_create (axis2_environment_t *
environment,
axis2_om_node_t * parent,
const axis2_char_t * target,
const axis2_char_t * value,
axis2_om_node_t ** node);
+/** frees given processing instruction */
#define axis2_om_processing_instruction_free(environment,pi) ((pi)->ops->axis2_om_processing_instruction_impl_free(environment,pi))
/** @} */
Modified: webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_processing_instruction.c
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_processing_instruction.c?rev=327969&r1=327968&r2=327969&view=diff
==============================================================================
--- webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_processing_instruction.c (original)
+++ webservices/axis2/trunk/c/modules/xml/om/src/axis2_om_processing_instruction.c Sun Oct 23 21:57:20 2005
@@ -16,7 +16,7 @@
#include <axis2_om_processing_instruction.h>
-axis2_status_t axis2_om_processing_instruction_impl_free (axis2_environment_t
+axis2_status_t AXIS2_CALL axis2_om_processing_instruction_impl_free (axis2_environment_t
* environment,
axis2_om_processing_instruction_t
*