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 09:22:08 UTC
svn commit: r348129 - in /webservices/axis2/trunk/c/include:
axis2_om_namespace.h axis2_om_node.h
Author: samisa
Date: Tue Nov 22 00:22:01 2005
New Revision: 348129
URL: http://svn.apache.org/viewcvs?rev=348129&view=rev
Log:
doc comments added
Modified:
webservices/axis2/trunk/c/include/axis2_om_namespace.h
webservices/axis2/trunk/c/include/axis2_om_node.h
Modified: webservices/axis2/trunk/c/include/axis2_om_namespace.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_namespace.h?rev=348129&r1=348128&r2=348129&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_namespace.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_namespace.h Tue Nov 22 00:22:01 2005
@@ -58,9 +58,9 @@
/**
* Compares two namepsaces
- * @param om_namespace1 first namespase to be compared
+ * @param om_namespace first namespase to be compared
* @param env Environment. MUST NOT be NULL.
- * @param om_namespace2 second namespace to be compared
+ * @param om_namespace1 second namespace to be compared
* @return AXIS2_TRUE if the two namespaces are equal,AXIS2_FALSE otherwise
*/
axis2_bool_t (AXIS2_CALL *equals)(struct axis2_om_namespace *om_namespace,
@@ -78,29 +78,34 @@
axis2_env_t **env,
axis2_om_output_t * om_output);
/**
- *@param om_namespace
- *@param env
+ *@param om_namespace pointer to om_namespace struct
+ *@param env environment , MUST NOT be NULL.
+ *@returns namespace uri , NULL on error
*/
axis2_char_t* (AXIS2_CALL *get_uri)(struct axis2_om_namespace *om_namespace,
axis2_env_t **env);
/**
- *@param om_namespace
- *@param env
+ *@param om_namespace pointer to om namespace struct
+ *@param env environment, MUST NOT be NULL
+ *@return prefix , NULL on error
*/
axis2_char_t* (AXIS2_CALL *get_prefix)(struct axis2_om_namespace *om_namespace,
axis2_env_t **env);
/**
- *@param om_namespace
- *@param env
- *@param uri
+ *@param om_namespace pointer to om namespace struct
+ *@param env environment, MUST NOT be NULL.
+ *@param uri namespace uri to be set
+ *@returns status of the operation AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
*/
axis2_status_t (AXIS2_CALL *set_uri)(struct axis2_om_namespace *om_namespace,
axis2_env_t **env,
const axis2_char_t *uri);
/**
- *@param om_namespace
- *@param env
- *@param prefix
+ *@param om_namespace pointer to om_namespace struct
+ *@param env environment struct
+ *@param prefix prefix to be set
+ *@returns status code of the operation AXIS2_SUCCESS on success,
+ * AXIS2_FAILURE on error.
*/
axis2_status_t (AXIS2_CALL *set_prefix)(struct axis2_om_namespace *om_namespace,
axis2_env_t **env,
Modified: webservices/axis2/trunk/c/include/axis2_om_node.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_om_node.h?rev=348129&r1=348128&r2=348129&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_om_node.h (original)
+++ webservices/axis2/trunk/c/include/axis2_om_node.h Tue Nov 22 00:22:01 2005
@@ -81,7 +81,6 @@
* Frees an om node and all of its children
* @param om_node node to be freed.
* @param env Environment. MUST NOT be NULL, .
-
* @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *free) (struct axis2_om_node *om_node,
@@ -90,7 +89,7 @@
* Adds given node as child to parent
* @param om_node child node. cannot be NULL.
* @param env Environment. MUST NOT be NULL, .
- * @param child child node. , cannot be NULL.
+ * @param child child node.
* @return satus of the operation. AXIS2_SUCCESS on success else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *add_child) (struct axis2_om_node *om_node,
@@ -99,15 +98,16 @@
/**
* Detaches given node from the parent and reset the links
- * @param om_node node to be detached. , cannot be NULL.
+ * @param om_node node to be detached, cannot be NULL.
* @param env Environment. MUST NOT be NULL, .
- * @return a pointer to detached node, NULL on error.
+ * @return a pointer to detached node,returns NULL on error with error
+ * code set to environment's error struct
*/
struct axis2_om_node *(AXIS2_CALL *detach) (struct axis2_om_node *om_node,
axis2_env_t **env);
/**
- * Inserts a sibling node after the given current node
+ * Inserts a sibling node after the given node
* @param om_node node to whom the sibling to be inserted. , cannot be NULL.
* @param env Environment. MUST NOT be NULL, .
* @param node_to_insert the node to be inserted. , cannot be NULL.
@@ -131,7 +131,8 @@
struct axis2_om_node * node_to_insert);
/**
- * Sets a parent node to a given node
+ * Sets a parent node to a given node, if a parent already exist for this node
+ * then it is detached before seting the parent
* @param om_node child node to whom a parent to be added. , cannot be NULL.
* @param env Environment. MUST NOT be NULL, .
* @param parent_node the node that will be set as parent. , cannot be NULL.
@@ -143,8 +144,8 @@
/**
- * Serializes the given node. This operation makes the node go through its children and
- * serialize them in order.
+ * Serializes the given node. This operation makes the node go
+ * through its children and serialize them in order.
* @param om_node node to be serialized. cannot be NULL.
* @param env Environment .MUST NOT be NULL.
* @param om_output OM output handler to be used in serializing
@@ -152,27 +153,69 @@
*/
axis2_status_t (AXIS2_CALL *serialize) (struct axis2_om_node * om_node, axis2_env_t **env,
struct axis2_om_output *om_output);
- /** getter setter methods *************************************/
+ /** get parent of om_node
+ *@om_node node
+ *@param env environment
+ *@return pointer to parent node of om_node, return NULL if no parent exists or
+ * when an error occured.
+ */
+
struct axis2_om_node* (AXIS2_CALL *get_parent)
(struct axis2_om_node *om_node,
axis2_env_t **env);
+ /**
+ * get the first child of om_node
+ * @param om_node node
+ * @param env environment must not be null.
+ * @returns pointer to first child node , NULL is returned on error with
+ * error code set in environments error
+ */
+
struct axis2_om_node* (AXIS2_CALL *get_first_child)
(struct axis2_om_node *om_node,
axis2_env_t **env);
+ /**
+ * get the last child
+ * @param om_node node
+ * @param env environment, MUST NOT be NULL
+ * @return pointer to last child of this node , return NULL on error.
+ */
struct axis2_om_node* (AXIS2_CALL *get_last_child)
(struct axis2_om_node *om_node,
axis2_env_t **env);
+ /**
+ * get the previous sibling
+ * @param om_node om_node struct
+ * @param env environment , must node be null
+ * @returns a pointer to previous sibling , NULL if a previous sibling does not exits
+ * (happens when this node is the first child of a node )
+ */
struct axis2_om_node* (AXIS2_CALL *get_previous_sibling)
(struct axis2_om_node *om_node,
axis2_env_t **env);
-
+ /**
+ * get next sibling
+ * @param om_node om_node struct
+ * @param env environment, MUST NOT be NULL.
+ * @return next sibling of this node.
+ */
+
+
struct axis2_om_node* (AXIS2_CALL *get_next_sibling)
(struct axis2_om_node *om_node,
axis2_env_t **env);
-
+ /**
+ * get the node type of this element
+ * Node type can be one of AXIS2_OM_ELEMENT, AXIS2_OM_COMMENT, AXIS2_OM_TEXT
+ * AXIS2_OM_DOCTYPE, AXIS2_OM_PROCESSING_INSTRUCTION
+ * @param om_node node of which node type is required
+ * @param env environment
+ * @return node type
+ */
+
axis2_om_types_t (AXIS2_CALL *get_node_type)
(struct axis2_om_node *om_node,
axis2_env_t **env);