axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From p...@apache.org
Subject svn commit: r426413 - in /webservices/axis2/trunk/c/util/include: axis2_array_list.h axis2_param_container.h axis2_utils.h
Date Fri, 28 Jul 2006 07:02:42 GMT
Author: pini
Date: Fri Jul 28 00:02:42 2006
New Revision: 426413

URL: http://svn.apache.org/viewvc?rev=426413&view=rev
Log:
Updated doxygen comments to clean doc structure

Modified:
    webservices/axis2/trunk/c/util/include/axis2_array_list.h
    webservices/axis2/trunk/c/util/include/axis2_param_container.h
    webservices/axis2/trunk/c/util/include/axis2_utils.h

Modified: webservices/axis2/trunk/c/util/include/axis2_array_list.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/util/include/axis2_array_list.h?rev=426413&r1=426412&r2=426413&view=diff
==============================================================================
--- webservices/axis2/trunk/c/util/include/axis2_array_list.h (original)
+++ webservices/axis2/trunk/c/util/include/axis2_array_list.h Fri Jul 28 00:02:42 2006
@@ -13,11 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
- 
+
 #ifndef AXIS2_ARRAY_LIST_H
 #define AXIS2_ARRAY_LIST_H
 
 /**
+ * @defgroup axis2_array_list array list
+ * @ingroup axis2_util
+ * Description.
+ * @{
+ */
+
+/**
  * @file axis2_array_list.h
  * @brief Axis2 array_list interface
  */
@@ -30,244 +37,312 @@
 {
 #endif
 
-struct axis2_array_list;
-struct axis2_array_list_ops;
-    
-static const int AXIS2_ARRAY_LIST_DEFAULT_CAPACITY = 16;
-    
-/**
- * @defgroup axis2_array_list array list
- * @ingroup axis2_util
- * @{
- */
+    struct axis2_array_list;
+    struct axis2_array_list_ops;
 
-   /**
-    *   \brief Array List ops struct
-    */
+    static const int AXIS2_ARRAY_LIST_DEFAULT_CAPACITY = 16;
+
+    /**
+     *  Array List ops struct
+     */
     AXIS2_DECLARE_DATA typedef struct axis2_array_list_ops
     {
-       /**
-        * Guarantees that this list will have at least enough capacity to
-        * hold min_capacity elements. This implementation will grow the list to
-        * max(current * 2, min_capacity)
-        *
-        * @param min_capacity the minimum guaranteed capacity
-        */
+        /**
+         * Guarantees that this list will have at least enough capacity to
+         * hold min_capacity elements. This implementation will grow the list to
+         * max(current * 2, min_capacity)
+         * @param array_list pointer to array_list
+	 * @param env pointer to environment struct
+         * @param min_capacity the minimum guaranteed capacity
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+         */
         axis2_status_t (AXIS2_CALL *
-        ensure_capacity) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                int min_capacity);
-        
-       /**
-        * Returns the number of elements in this list.
-        *
-        * @return the list size
-        */
+                ensure_capacity)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    int min_capacity);
+
+        /**
+         * Returns the number of elements in this list.
+         * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @return the list size
+         */
         int (AXIS2_CALL *
-        size) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env);
-        
-       /**
-        * Checks if the list is empty.
-        *
-        * @return true if there are no elements, else false
-        */
+                size)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env);
+
+        /**
+         * Checks if the list is empty.
+         * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @return true if there are no elements, else false
+         */
         axis2_bool_t (AXIS2_CALL *
-        is_empty) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env);
-        
-       /**
-        * Returns true iff element is in this array_list.
-        *
-        * @param e the element whose inclusion in the List is being tested
-        * @return true if the list contains e
-        */
+                is_empty)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env);
+
+        /**
+         * Returns true iff element is in this array_list.
+         * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param e the element whose inclusion in the List is being tested
+         * @return true if the list contains e
+         */
         axis2_bool_t (AXIS2_CALL *
-        contains) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                void *e);
-            
-       /**
-        * Returns the lowest index at which element appears in this List, or
-        * -1 if it does not appear. This looks for the pointer value equality only, 
-        * does not look into pointer content
-        *
-        * @param e the element whose inclusion in the List is being tested
-        * @return the index where e was found
-        */
+                contains)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    void *e);
+
+        /**
+         * Returns the lowest index at which element appears in this List, or
+         * -1 if it does not appear. This looks for the pointer value equality only, 
+         * does not look into pointer content
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param e the element whose inclusion in the List is being tested
+         * @return the index where e was found
+         */
         int (AXIS2_CALL *
-        index_of) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                void *e);
-        
-       /**
-        * Returns the highest index at which element appears in this List, or
-        * -1 if it does not appear. This looks for the pointer value equality only, 
-        * does not look into pointer content
-        *
-        * @param e the element whose inclusion in the List is being tested
-        * @return the index where e was found
-        */
+                index_of)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    void *e);
+
+        /**
+         * Returns the highest index at which element appears in this List, or
+         * -1 if it does not appear. This looks for the pointer value equality only, 
+         * does not look into pointer content
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param e the element whose inclusion in the List is being tested
+         * @return the index where e was found
+         */
         int (AXIS2_CALL *
-        last_index_of) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                void *e);
-        
-       /**
-        * Returns a void* array containing all of the elements in this array_list.
-        * The array is not independent of this list.
-        *
-        * @return array of elements in this list
-        */
+                last_index_of)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    void *e);
+
+        /**
+         * Returns a void* array containing all of the elements in this array_list.
+         * The array is not independent of this list.
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @return array of elements in this list
+         */
         void** (AXIS2_CALL *
-        to_array) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env);
-        
-       /**
-        * Retrieves the element at the user-supplied index.
-        *
-        * @param index the index of the element we are fetching
-        * @return element at the given index
-        */
+                to_array)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env);
+
+        /**
+         * Retrieves the element at the user-supplied index.
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param index the index of the element we are fetching
+         * @return element at the given index
+         */
         void* (AXIS2_CALL *
-        get) (struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                int index);
-        
-       /**
-        * Sets the element at the specified index.  The new element, e,
-        * can be an object of any type or null.
-        *
-        * @param index the index at which the element is being set
-        * @param e the element to be set
-        * @return the element previously at the specified index
-        */
+                get)(struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    int index);
+
+        /**
+         * Sets the element at the specified index.  The new element, e,
+         * can be an object of any type or null.
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param index the index at which the element is being set
+         * @param e the element to be set
+         * @return the element previously at the specified index
+         */
         void* (AXIS2_CALL *
-        set) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                int index, 
-                void* e);
-        
-       /**
-        * Appends the supplied element to the end of this list.
-        * The element, e, can be a pointer of any type or NULL.
-        *
-        * @param e the element to be appended to this list
-        * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
-        */
+                set)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    int index,
+                    void* e);
+
+        /**
+         * Appends the supplied element to the end of this list.
+         * The element, e, can be a pointer of any type or NULL.
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param e the element to be appended to this list
+         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+         */
         axis2_status_t (AXIS2_CALL *
-        add) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                const void* e);
-        
-       /**
-        * Adds the supplied element at the specified index, shifting all
-        * elements currently at that index or higher one to the right.
-        * The element, e, can be a pointer of any type or NULL.
-        *
-        * @param index the index at which the element is being added
-        * @param e the item being added
-        * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
-        */
+                add)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    const void* e);
+
+        /**
+         * Adds the supplied element at the specified index, shifting all
+         * elements currently at that index or higher one to the right.
+         * The element, e, can be a pointer of any type or NULL.
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param index the index at which the element is being added
+         * @param e the item being added
+         * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+         */
         axis2_status_t (AXIS2_CALL *
-        add_at) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                const int index, 
-                const void* e);
-        
-       /**
-        * Removes the element at the user-supplied index.
-        *
-        * @param index the index of the element to be removed
-        * @return the removed void* pointer
-        */
+                add_at)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    const int index,
+                    const void* e);
+
+        /**
+         * Removes the element at the user-supplied index.
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param index the index of the element to be removed
+         * @return the removed void* pointer
+         */
         void* (AXIS2_CALL *
-        remove) (struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                int index);
-        
-       /**
-        * Checks that the index is in the range of possible elements (inclusive).
-        *
-        * @param index the index to check
-        * @return AXIS2_FALSE if index > size or index < 0, else AXIS2_TRUE
-        */
+                remove)(struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    int index);
+
+        /**
+         * Checks that the index is in the range of possible elements (inclusive).
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param index the index to check
+         * @return AXIS2_FALSE if index > size or index < 0, else AXIS2_TRUE
+         */
         axis2_bool_t (AXIS2_CALL *
-        check_bound_inclusive) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                int index);
-        
-       /**
-        * Checks that the index is in the range of existing elements (exclusive).
-        *
-        * @param index the index to check
-        * @return AXIS2_FALSE if index >= size or index < 0, else AXIS2_TRUE
-        */
+                check_bound_inclusive)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    int index);
+
+        /**
+         * Checks that the index is in the range of existing elements (exclusive).
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+         * @param index the index to check
+         * @return AXIS2_FALSE if index >= size or index < 0, else AXIS2_TRUE
+         */
         axis2_bool_t (AXIS2_CALL *
-        check_bound_exclusive) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env, 
-                int index);
-            
+                check_bound_exclusive)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env,
+                    int index);
+
+        /**
+	 * @param array_list pointer to array list
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
         axis2_status_t (AXIS2_CALL *
-        free) (
-                struct axis2_array_list *array_list, 
-                const axis2_env_t *env);
-
-    } axis2_array_list_ops_t;
-
-   /** 
-    * \brief Array List struct
-    */
-     
+                free)(
+                    struct axis2_array_list *array_list,
+                    const axis2_env_t *env);
+
+    }
+    axis2_array_list_ops_t;
+
+    /**
+     * Array List struct
+     */
+
     typedef struct axis2_array_list
     {
         /** Handler Description related ops */
         axis2_array_list_ops_t *ops;
-    } axis2_array_list_t;
+    }
+    axis2_array_list_t;
 
-   /**
-    * Constructs a new array list with the supplied initial capacity.
-    * If capacity is invalid (<= 0) then default capacity is used
-    * @param capacity initial capacity of this array_list
-    */
+    /**
+     * Constructs a new array list with the supplied initial capacity.
+     * If capacity is invalid (<= 0) then default capacity is used
+     * @param env pointer to environment struct
+     * @param capacity initial capacity of this array_list
+     */
+    AXIS2_EXTERN axis2_array_list_t* AXIS2_CALL axis2_array_list_create(
+        const axis2_env_t *env, 
+	int capacity);
 
-    AXIS2_EXTERN axis2_array_list_t* AXIS2_CALL axis2_array_list_create(const axis2_env_t
*env, int capacity);
     /**
      * Free array passed as void pointer.
+     * @param array_list pointer to array list
+     * @param env pointer to environment struct
      */
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axis2_array_list_free_void_arg(
-            void *array_list, 
-            const axis2_env_t *env);
+        void *array_list,
+        const axis2_env_t *env);
 
 
-#define AXIS2_ARRAY_LIST_FREE(array_list, env) ((array_list)->ops->free(array_list,
env))
-#define AXIS2_ARRAY_LIST_SIZE(array_list, env) ((array_list)->ops->size(array_list,
env))
-#define AXIS2_ARRAY_LIST_IS_EMPTY(array_list, env) ((array_list)->ops->is_empty(array_list,
env))
-#define AXIS2_ARRAY_LIST_CONTAINS(array_list, env, e) ((array_list)->ops->contains(array_list,
env, e))
-#define AXIS2_ARRAY_LIST_INDEX_OF(array_list, env, e) ((array_list)->ops->index_of(array_list,
env, e))
-#define AXIS2_ARRAY_LIST_LAST_INDEX_OF(array_list, env, e) ((array_list)->ops->last_index_of(array_list,
env, e))    
-#define AXIS2_ARRAY_LIST_TO_ARRAY(array_list, env) ((array_list)->ops->index_of(array_list,
env))
-#define AXIS2_ARRAY_LIST_GET(array_list, env, index) ((array_list)->ops->get(array_list,
env, index))
-#define AXIS2_ARRAY_LIST_SET(array_list, env, index, e) ((array_list)->ops->set(array_list,
env, index, e))
-#define AXIS2_ARRAY_LIST_ADD(array_list, env, e) ((array_list)->ops->add(array_list,
env, e))
-#define AXIS2_ARRAY_LIST_ADD_AT(array_list, env, index, e) ((array_list)->ops->add_at(array_list,
env, index, e))
-#define AXIS2_ARRAY_LIST_REMOVE(array_list, env, index) ((array_list)->ops->remove(array_list,
env, index))
+/** Frees the axis2 array list.
+    @sa axis2_array_list_ops#free */
+#define AXIS2_ARRAY_LIST_FREE(array_list, env) \
+        ((array_list)->ops->free(array_list, env))
+
+/** Size.
+    @sa axis2_array_list_ops#size */
+#define AXIS2_ARRAY_LIST_SIZE(array_list, env) \
+        ((array_list)->ops->size(array_list, env))
+
+/** Is empty.
+    @sa axis2_array_list_ops#is_empty */
+#define AXIS2_ARRAY_LIST_IS_EMPTY(array_list, env) \
+        ((array_list)->ops->is_empty(array_list, env))
+
+/** Contains.
+    @sa axis2_array_list_ops#contains */
+#define AXIS2_ARRAY_LIST_CONTAINS(array_list, env, e) \
+        ((array_list)->ops->contains(array_list, env, e))
+
+/** Index of.
+    @sa axis2_array_list_ops#index_of */
+#define AXIS2_ARRAY_LIST_INDEX_OF(array_list, env, e) \
+        ((array_list)->ops->index_of(array_list, env, e))
+
+/** Last index of.
+    @sa axis2_array_list_ops#last_index_of */
+#define AXIS2_ARRAY_LIST_LAST_INDEX_OF(array_list, env, e) \
+        ((array_list)->ops->last_index_of(array_list, env, e))
+
+/** To array.
+    @sa axis2_array_list_ops#to_array */
+#define AXIS2_ARRAY_LIST_TO_ARRAY(array_list, env) \
+        ((array_list)->ops->index_of(array_list, env))
+
+/** Get.
+    @sa axis2_array_list_ops#get */
+#define AXIS2_ARRAY_LIST_GET(array_list, env, index) \
+        ((array_list)->ops->get(array_list, env, index))
+
+/** Set.
+    @sa axis2_array_list_ops#set */
+#define AXIS2_ARRAY_LIST_SET(array_list, env, index, e) \
+        ((array_list)->ops->set(array_list, env, index, e))
+
+/** Add.
+    @sa axis2_array_list_ops#add */
+#define AXIS2_ARRAY_LIST_ADD(array_list, env, e) \
+        ((array_list)->ops->add(array_list, env, e))
+
+/** Add at.
+    @sa axis2_array_list_ops#add_at */
+#define AXIS2_ARRAY_LIST_ADD_AT(array_list, env, index, e) \
+        ((array_list)->ops->add_at(array_list, env, index, e))
+
+/** Remove.
+    @sa axis2_array_list_ops#remove */
+#define AXIS2_ARRAY_LIST_REMOVE(array_list, env, index) \
+        ((array_list)->ops->remove(array_list, env, index))
 
 /** @} */
-    
+
 #ifdef __cplusplus
 }
 #endif

Modified: webservices/axis2/trunk/c/util/include/axis2_param_container.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/util/include/axis2_param_container.h?rev=426413&r1=426412&r2=426413&view=diff
==============================================================================
--- webservices/axis2/trunk/c/util/include/axis2_param_container.h (original)
+++ webservices/axis2/trunk/c/util/include/axis2_param_container.h Fri Jul 28 00:02:42 2006
@@ -17,6 +17,11 @@
 #ifndef AXIS2_PARAM_CONTAINER_H
 #define AXIS2_PARAM_CONTAINER_H
 
+/** @defgroup axis2_param_container Parameter Container
+ * @ingroup axis2_descript
+ * @{
+ */
+
 /**
  * @file axis2_param_container.h
  * @brief Axis2 Param container interface
@@ -49,11 +54,6 @@
  * should also be assigned to param free function
  */
 typedef axis2_status_t (AXIS2_CALL *AXIS2_PARAM_VALUE_FREE)(void *param, const axis2_env_t
*env);    
-
-/** @defgroup axis2_param_container Parameter Container
- * @ingroup axis2_description
- * @{
- */
 
 /** 
  * @brief Param Container ops struct

Modified: webservices/axis2/trunk/c/util/include/axis2_utils.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/util/include/axis2_utils.h?rev=426413&r1=426412&r2=426413&view=diff
==============================================================================
--- webservices/axis2/trunk/c/util/include/axis2_utils.h (original)
+++ webservices/axis2/trunk/c/util/include/axis2_utils.h Fri Jul 28 00:02:42 2006
@@ -34,6 +34,11 @@
  * @{
  */
 
+/**
+ * @file axis2_utils.h
+ */
+
+
 /** This macro is called to check whether structure on which function is called
  *  is NULL and to check whether the environment structure passed is valid.
  * @param object structure on which function is called



---------------------------------------------------------------------
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