axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sam...@apache.org
Subject svn commit: r367927 - in /webservices/axis2/trunk/c: include/axis2_any_content_type.h modules/core/addr/any_content_type.c
Date Wed, 11 Jan 2006 05:05:19 GMT
Author: samisa
Date: Tue Jan 10 21:05:11 2006
New Revision: 367927

URL: http://svn.apache.org/viewcvs?rev=367927&view=rev
Log:
Fixed doc comments

Modified:
    webservices/axis2/trunk/c/include/axis2_any_content_type.h
    webservices/axis2/trunk/c/modules/core/addr/any_content_type.c

Modified: webservices/axis2/trunk/c/include/axis2_any_content_type.h
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/include/axis2_any_content_type.h?rev=367927&r1=367926&r2=367927&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_any_content_type.h (original)
+++ webservices/axis2/trunk/c/include/axis2_any_content_type.h Tue Jan 10 21:05:11 2006
@@ -37,57 +37,82 @@
     struct axis2_any_content_type_ops;
     
 /**
- * @defgroup axis2_any_content_type Addressing relates to header
+ * @defgroup axis2_any_content_type WS Addressing any content type
  * @ingroup axis2_addr
  * @{
  */
 
 /**
- *   \brief Dispatcher ops struct
+ *   \brief any_content_type ops struct
  */
  AXIS2_DECLARE_DATA typedef struct axis2_any_content_type_ops
     { 
         /**
-         * Method addReferenceValue
-         *
-         * @param name
-         * @param value
+         * Adds given value to the content value map.
+         * @param any_content_type any_content_type struct. cannot be NULL.
+         * @param env Environment. MUST NOT be NULL.
+         * @param value value to be added.
+         * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
          */
         axis2_status_t (AXIS2_CALL *add_value)(struct axis2_any_content_type *any_content_type,
axis2_env_t **env, axis2_qname_t *qname, axis2_char_t *value); 
+       
         /**
-         * Method getReferenceValue
-         *
-         * @param qname
-         * @return
+         * Gets the value from the content value map.
+         * @param any_content_type any_content_type struct. cannot be NULL.
+         * @param env Environment. MUST NOT be NULL.
+         * @param qname qname of the corresponging value to be retrived
+         * @return Pointer to the value if present, else returns NULL. 
+         *          Environment status would be set to AXIS2_FAILURE on error.
          */
         axis2_char_t* (AXIS2_CALL *get_value)(struct axis2_any_content_type *any_content_type,
axis2_env_t **env, axis2_qname_t *qname);
+        /**
+         * Gets the map of values
+         * @param any_content_type any_content_type struct. cannot be NULL.
+         * @param env Environment. MUST NOT be NULL.
+         * @return Pointer to the value map. Would return NULL and set 
+         *          Environment status to AXIS2_FAILURE on error.
+         */
         axis2_hash_t* (AXIS2_CALL *get_value_map)(struct axis2_any_content_type *any_content_type,
axis2_env_t **env);
+        /**
+         * Frees the given any_content_type struct
+         * @param any_content_type any_content_type struct. cannot be NULL.
+         * @param env Environment. MUST NOT be NULL.
+         * @return AXIS2_SUCCESS on success else AXIS2_FAILURE
+         */
         axis2_status_t (AXIS2_CALL *free)(struct axis2_any_content_type *any_content_type,

                                                        axis2_env_t **env);
     } axis2_any_content_type_ops_t;
 	
    /** 
-    * \brief Dispatcher struct
+    * \brief axis2_any_content_type struct
     */
     typedef struct axis2_any_content_type
     {
-        /** Dispatcher related ops */
+        /** axis2_any_content_type related ops */
         axis2_any_content_type_ops_t *ops;
     } axis2_any_content_type_t;
 
 
 /**
- * creates any_content_type struct
- *
- * @param value
- * @param relationship_type
+ * creates an instance of any_content_type struct
+ * @param env Environment. MUST NOT be NULL.
+ * @return Pointer to the newly created any_content_type instance. Returns NULL on error.
  */
 AXIS2_DECLARE(axis2_any_content_type_t*) axis2_any_content_type_create(axis2_env_t **env);
     
-#define AXIS2_ANY_CONTENT_TYPE_ADD_VALUE(any_content_type, env, qname, value) ((any_content_type)->ops->add_value(any_content_type,
env, qname, value))
-#define AXIS2_ANY_CONTENT_TYPE_GET_VALUE(any_content_type, env, qname) ((any_content_type)->ops->get_value(any_content_type,
env, qname))
-#define AXIS2_ANY_CONTENT_TYPE_GET_VALUE_MAP(any_content_type, env) ((any_content_type)->ops->get_value_map(any_content_type,
env))
-#define AXIS2_ANY_CONTENT_TYPE_FREE(any_content_type, env) ((any_content_type)->ops->free(any_content_type,
env))
+    
+/**************************** Start of function macros ************************/    
+#define AXIS2_ANY_CONTENT_TYPE_ADD_VALUE(any_content_type, env, qname, value) \
+    ((any_content_type)->ops->add_value(any_content_type, env, qname, value))
+    
+#define AXIS2_ANY_CONTENT_TYPE_GET_VALUE(any_content_type, env, qname) \
+    ((any_content_type)->ops->get_value(any_content_type, env, qname))
+    
+#define AXIS2_ANY_CONTENT_TYPE_GET_VALUE_MAP(any_content_type, env) \
+    ((any_content_type)->ops->get_value_map(any_content_type, env))
+    
+#define AXIS2_ANY_CONTENT_TYPE_FREE(any_content_type, env) \
+    ((any_content_type)->ops->free(any_content_type, env))
 
     
 /** @} */

Modified: webservices/axis2/trunk/c/modules/core/addr/any_content_type.c
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/modules/core/addr/any_content_type.c?rev=367927&r1=367926&r2=367927&view=diff
==============================================================================
--- webservices/axis2/trunk/c/modules/core/addr/any_content_type.c (original)
+++ webservices/axis2/trunk/c/modules/core/addr/any_content_type.c Tue Jan 10 21:05:11 2006
@@ -78,12 +78,6 @@
     return &(any_content_type_impl->any_content_type);
 }
 
-/**
- * Method addReferenceValue
- *
- * @param name
- * @param value
- */
 axis2_status_t AXIS2_CALL axis2_any_content_type_add_value(struct axis2_any_content_type
*any_content_type, axis2_env_t **env, axis2_qname_t *qname, axis2_char_t *value) 
 {
     axis2_any_content_type_impl_t *any_content_type_impl = NULL;
@@ -99,12 +93,6 @@
     return AXIS2_SUCCESS;
 }
 
-/**
- * Method getReferenceValue
- *
- * @param qname
- * @return
- */
 axis2_char_t* AXIS2_CALL axis2_any_content_type_get_value(struct axis2_any_content_type *any_content_type,
axis2_env_t **env, axis2_qname_t *qname) 
 {
     axis2_any_content_type_impl_t *any_content_type_impl = NULL;



Mime
View raw message