axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lah...@apache.org
Subject svn commit: r643783 - /webservices/axis2/trunk/c/axiom/include/axiom_util.h
Date Wed, 02 Apr 2008 08:04:51 GMT
Author: lahiru
Date: Wed Apr  2 01:04:48 2008
New Revision: 643783

URL: http://svn.apache.org/viewvc?rev=643783&view=rev
Log:
added method discription to axiom_util.h header

Modified:
    webservices/axis2/trunk/c/axiom/include/axiom_util.h

Modified: webservices/axis2/trunk/c/axiom/include/axiom_util.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/axiom/include/axiom_util.h?rev=643783&r1=643782&r2=643783&view=diff
==============================================================================
--- webservices/axis2/trunk/c/axiom/include/axiom_util.h (original)
+++ webservices/axis2/trunk/c/axiom/include/axiom_util.h Wed Apr  2 01:04:48 2008
@@ -28,13 +28,30 @@
 extern "C"
 {
 #endif
-
+    /**
+     * After calling this method the variable child points to
+     * the node of the returning element
+     * @param ele_node axiom node 
+     * @param env environment, MUST not be NULL   
+     * @param uri uri 
+     * return the first child element which has the given uri 
+     */
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_first_child_element_with_uri(
         axiom_node_t * ele_node,
         const axutil_env_t * env,
         axis2_char_t * uri,
         axiom_node_t ** child);
+    /**
+     * After calling this method next_node will point to the
+     * previous sibling node to the returning node
+     * @param ele_node axiom node 
+     * @param env environment, MUST not be NULL   
+     * @param uri uri
+     * @param next_node
+     * return the next sibling element to the element which contains
+     * the give namespace uri
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_next_sibling_element_with_uri(
@@ -42,20 +59,41 @@
         const axutil_env_t * env,
         axis2_char_t * uri,
         axiom_node_t ** next_node);
-
+    /**
+     * @param eleaxiom node 
+     * @param env environment, MUST not be NULL   
+     * @param ele_node
+     * @param child_node
+     * return the first child element this calls the method
+     * axiom_element_get_first_child_element 
+     * 
+     */
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_first_child_element(
         axiom_element_t * ele,
         const axutil_env_t * env,
         axiom_node_t * ele_node,
         axiom_node_t ** child_node);
-
+    /**
+     * @param ele axiom element
+     * @param env environment, MUST not be NULL   
+     * @param ele_node
+     * @param child_node
+     * return the last child element of the  given element ele_node
+     */
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_last_child_element(
         axiom_element_t * ele,
         const axutil_env_t * env,
         axiom_node_t * ele_node,
         axiom_node_t ** child_node);
+    /**
+     * @param ele axiom node 
+     * @param env environment, MUST not be NULL   
+     * @param ele_node
+     * @param next_node
+     * return the first child element which has the given uri 
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_next_sibling_element(
@@ -63,6 +101,16 @@
         const axutil_env_t * env,
         axiom_node_t * ele_node,
         axiom_node_t ** next_node);
+    /**
+     * @param ele axiom element
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param localname localname to find the first child element
+     * @param child_node
+     * 
+     * return the first child element from ele_node which contains the
+     * given local name
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_first_child_element_with_localname(
@@ -71,6 +119,14 @@
         axiom_node_t * ele_node,
         axis2_char_t * localname,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param localname to find the last child element
+     * @param child_node
+     * return the last child element which having the given local name
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_last_child_element_with_localname(
@@ -79,6 +135,14 @@
         axiom_node_t * ele_node,
         axis2_char_t * localname,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param localname to find the last child element
+     * @param next_node
+     * return the next sibling element which is having the given local name
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_next_siblng_element_with_localname(
@@ -87,6 +151,16 @@
         axiom_node_t * ele_node,
         axis2_char_t * localname,
         axiom_node_t ** next_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param localname to find the last child element
+     * @param uri uri to of the namespace to find the first element
+     * @param next_node
+     * return the first child element which is having the given local
+     * name and the given namespace uri
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_first_child_element_with_uri_localname(
@@ -96,6 +170,17 @@
         axis2_char_t * localname,
         axis2_char_t * uri,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param localname to find the last child element
+     * @param uri uri of the namespace to find the last element
+     * @param next_node
+     * return the last child element which is having the given local name and
+     * the given namespace uri
+     */
+
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_last_child_element_with_uri_localname(
         axiom_element_t * ele,
@@ -104,6 +189,16 @@
         axis2_char_t * localname,
         axis2_char_t * uri,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param localname to find the last child element
+     * @param uri uri of the namespace to find the last element
+     * @param next_node
+     * return next sibling element which is having the given local name and
+     * the given namespace uri
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_next_sibling_element_with_uri_localname(
@@ -113,6 +208,14 @@
         axis2_char_t * localname,
         axis2_char_t * uri,
         axiom_node_t ** next_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param names local names to find the child element 
+     * @param child_node
+     * return the first child element which is having all the localnames given
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_first_child_element_with_localnames(
@@ -121,6 +224,14 @@
         axiom_node_t * ele_node,
         axutil_array_list_t * names,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param names local names to find the last child element
+     * @param child_node
+     * return the last child element which is having all the localnames given
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_last_child_element_with_localnames(
@@ -129,6 +240,14 @@
         axiom_node_t * ele_node,
         axutil_array_list_t * names,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node axiom node 
+     * @param names local names to find the next sibling
+     * @param child_node
+     * return the next sibling element which is having all the localnames given
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_next_siblng_element_with_localnames(
@@ -137,7 +256,17 @@
         axiom_node_t * ele_node,
         axutil_array_list_t * names,
         axiom_node_t ** next_node);
-
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node
+     * @param localname local name to find the first child
+     * @param attr_name attribute name to find first child
+     * @param attr_value attribute value of attr_name attribute
+     * @param child_node 
+     * return the first child element which is having the given local
+     * name and the given attribute (attribute name and attribute value)
+     */
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_first_child_element_with_localname_attr(
         axiom_element_t * ele,
@@ -147,6 +276,18 @@
         axis2_char_t * attr_name,
         axis2_char_t * attr_value,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node
+     * @param localname local name to find the last child
+     * @param attr_name attribute name to find last child
+     * @param attr_value attribute value of attr_name attribute
+     * @param child_node 
+     * return the last child element which is having the given local
+     * name and the given attribute (attribute name and attribute value)
+     */
+ 
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_last_child_element_with_localname_attr(
@@ -157,31 +298,69 @@
         axis2_char_t * attr_name,
         axis2_char_t * attr_value,
         axiom_node_t ** child_node);
+    /**
+     * @param ele
+     * @param env environment, MUST not be NULL   
+     * @param ele_node
+     * @param localname local name to find the next sibling child
+     * @param attr_name attribute name to find the next sibling child
+     * @param attr_value attribute value of attr_name attribute
+     * @param child_node 
+     * return the next sibling child element which is having the given local
+     * name and the given attribute (attribute name and attribute value)
+     */
 
     AXIS2_EXTERN axiom_element_t *AXIS2_CALL
     axiom_util_get_next_siblng_element_with_localname_attr(
         axiom_element_t * ele,
-        const axutil_env_t * env,
+        const axutil_env_t * env, 
         axiom_node_t * ele_node,
         axis2_char_t * localname,
         axis2_char_t * attr_name,
         axis2_char_t * attr_value,
         axiom_node_t ** next_node);
+    /**
+     * @param node axiom node 
+     * @param env environment, MUST not be NULL   
+     * 
+     * return the element text of axiom_node
+     */
 
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_util_get_child_text(
         axiom_node_t * node,
         const axutil_env_t * env);
+    /**
+     * @param node axiom node 
+     * @param env environment, MUST not be NULL   
+     *
+     * return the local name of axiom_node
+     */
 
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_util_get_localname(
         axiom_node_t * node,
         const axutil_env_t * env);
+    /**
+     * @param om_node axiom node 
+     * @param env environment, MUST not be NULL   
+     * 
+     * return the namespace uri of the give node variable om_node if
+     * there's no namespace in that particular om_node this method
+     * returns NULL
+     */
 
     AXIS2_EXTERN axis2_char_t *AXIS2_CALL
     axiom_util_get_node_namespace_uri(
         axiom_node_t * om_node,
         const axutil_env_t * env);
+    /**
+     * @param om_ele axiom node 
+     * @param env environment, MUST not be NULL   
+     * @param om_node
+     * return all the child element using the method
+     * axiom_child_element_iterator_create
+     */
 
     AXIS2_EXTERN axiom_child_element_iterator_t *AXIS2_CALL
     axiom_util_get_child_elements(
@@ -195,6 +374,6 @@
         const axutil_uri_t * uri);
 
 #ifdef __cplusplus
-}
+ }
 #endif
 #endif                          /* AXIOM_UTIL_H */



---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org


Mime
View raw message