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 07:01:51 UTC
svn commit: r348102 - /webservices/axis2/trunk/c/include/axis2_om_doctype.h
Author: samisa
Date: Mon Nov 21 22:01:46 2005
New Revision: 348102
URL: http://svn.apache.org/viewcvs?rev=348102&view=rev
Log:
doc comments added
Modified:
webservices/axis2/trunk/c/include/axis2_om_doctype.h
Modified: webservices/axis2/trunk/c/include/axis2_om_doctype.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_doctype.h?rev=348102&r1=348101&r2=348102&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_doctype.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_doctype.h Mon Nov 21 22:01:46 2005
@@ -47,26 +47,41 @@
{
/**
* free doctype struct
- * @param om_doctype pointer to doctype struct to be freed
+ * @param om_doctype pointer to axis2_om_doctype_t struct to be freed
* @param env Environment. MUST NOT be NULL,
* @return satus of the operation. AXIS2_SUCCESS on success
- * else AXIS2_FAILURE
+ * AXIS2_FAILURE on error.
*/
axis2_status_t (AXIS2_CALL *free)(struct axis2_om_doctype *om_doctype,
axis2_env_t **env);
/**
- * @param om_doctype pointer to a om_doctype struct
+ * @param om_doctype pointer to a axis2_om_doctype_t struct
* @param env environment must not be null
- * @return value
+ * @return DTD text
*/
axis2_char_t* (AXIS2_CALL *get_value)
(struct axis2_om_doctype *om_doctype,
axis2_env_t **env);
+ /**
+ * @param om_doctype pointer to axis2_om doctype_t struct
+ * @param env environment , MUST NOT be NULL.
+ * @param value doctype text value
+ * @return status of the operation,
+ * AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
+ */
axis2_status_t (AXIS2_CALL *set_value)
(struct axis2_om_doctype *om_doctype,
axis2_env_t **env,
const axis2_char_t *value);
+ /**
+ * serialize operation
+ * @param om_doctype pointer to axis2_om_doctype_t struct
+ * @param env environment , MUST NOT be NULL
+ * @param om_output pointer to axis2_om_output_t struct
+ * @returns status of the operation,
+ * AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
+ */
axis2_status_t (AXIS2_CALL *serialize)
(struct axis2_om_doctype *om_doctype,
@@ -87,10 +102,10 @@
} axis2_om_doctype_t;
/**
- * Creates a doctype struct
+ * Creates a axis2_om_doctype_t struct
* @param env Environment. MUST NOT be NULL,
* @param parent parent of the new node. Optinal, can be NULL.
- * @param value doctype value
+ * @param value doctype text
* @param node This is an out parameter.cannot be NULL.
* Returns the node corresponding to the doctype created.
* Node type will be set to AXIS2_OM_DOCTYPE
@@ -111,7 +126,7 @@
/** set the doctype value */
#define AXIS2_OM_DOCTYPE_SET_VALUE(doctype, env, value) \
((doctype)->ops->set_value(doctype, env, value))
-
+/** serialize operation */
#define AXIS2_OM_DOCTYPE_SERIALIZE(doctype, env, om_output) \
((doctype)->ops->serialize(doctype, env, om_output))