axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From p...@apache.org
Subject svn commit: r423398 - /webservices/axis2/trunk/c/include/axis2_ctx.h
Date Wed, 19 Jul 2006 07:52:03 GMT
Author: pini
Date: Wed Jul 19 00:52:02 2006
New Revision: 423398

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


Modified:
    webservices/axis2/trunk/c/include/axis2_ctx.h

Modified: webservices/axis2/trunk/c/include/axis2_ctx.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_ctx.h?rev=423398&r1=423397&r2=423398&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_ctx.h (original)
+++ webservices/axis2/trunk/c/include/axis2_ctx.h Wed Jul 19 00:52:02 2006
@@ -1,27 +1,39 @@
 /*
- * Copyright 2004,2005 The Apache Software Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright 2004,2005 The Apache Software Foundation.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
 
 #ifndef AXIS2_CTX_H
 #define AXIS2_CTX_H
 
+/**
+ * @defgroup axis2_context context hierarchy
+ * @ingroup axis2
+ * @{
+ * @}
+ */
+
+/** @defgroup axis2_ctx context
+ * @ingroup axis2_context
+ * Description.
+ * @{
+ */
 
 /**
-  * @file axis2_ctx.h
-  * @brief axis2 context interface
-  */
+ * @file axis2_ctx.h
+ * @brief axis2 context interface
+ */
 
 #include <axis2_defines.h>
 #include <axis2_hash.h>
@@ -33,108 +45,157 @@
 {
 #endif
 
-/** 
-  * @defgroup axis2_context context hierarchy
-  * @ingroup axis2
-  * @{
-  * @}
-  */
-    
-/** @defgroup axis2_ctx context 
- * @ingroup axis2_context
- * @{
- */
-    
-typedef struct axis2_ctx_ops axis2_ctx_ops_t;
-typedef struct axis2_ctx axis2_ctx_t; 
-
-    
-/** 
- * @brief context ops struct
- * Encapsulator struct for ops of axis2_ctx
- */  
-struct axis2_ctx_ops
-{
+
+    /** Type name for struct axis2_ctx_ops */
+    typedef struct axis2_ctx_ops axis2_ctx_ops_t;
+    /** Type name for struct axis2_ctx */
+    typedef struct axis2_ctx axis2_ctx_t;
+
+
     /**
-     * Stores a key value pair depending on the persistent flag.
-     *
-     * @param key
-     * @param value
-     * @param persistent
+     * @brief context ops struct
+     * Encapsulator struct for ops of axis2_ctx
      */
-    axis2_status_t (AXIS2_CALL *
-    set_property)(struct axis2_ctx *ctx, 
-                    const axis2_env_t *env, 
-                    const axis2_char_t *key, 
-                    axis2_property_t *value, 
+    struct axis2_ctx_ops
+    {
+        /**
+         * Stores a key value pair depending on the persistent flag.
+	 * @param ctx pointer to context struct
+	 * @param env pointer to environment struct
+         * @param key pointer to key
+         * @param value pointer to value
+         * @param persistent persistent
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+         */
+        axis2_status_t (AXIS2_CALL *
+                set_property)(
+                    struct axis2_ctx *ctx,
+                    const axis2_env_t *env,
+                    const axis2_char_t *key,
+                    axis2_property_t *value,
+                    const axis2_bool_t persistent);
+
+        /**
+	 * @param ctx pointer to context struct
+	 * @param env pointer to environment struct
+         * @param key pointer to key
+         * @param persistent persistent
+         */
+        axis2_property_t *(AXIS2_CALL *
+                get_property)(
+                    struct axis2_ctx *ctx,
+                    const axis2_env_t *env,
+                    const axis2_char_t *key,
                     const axis2_bool_t persistent);
-    
+
+	/**
+	 * @param ctx pointer to context struct
+	 * @param env pointer to environment struct
+	 */
+        axis2_hash_t* (AXIS2_CALL *
+                get_non_persistent_map)(
+                    struct axis2_ctx *ctx,
+                    const axis2_env_t *env);
+
+	/**
+	 * @param ctx pointer to context struct
+	 * @param env pointer to environment struct
+	 */
+        axis2_hash_t* (AXIS2_CALL *
+                get_persistent_map)(
+                    struct axis2_ctx *ctx,
+                    const axis2_env_t *env);
+
+        /**
+         * Deallocate memory
+	 * @param ctx pointer to context struct
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+         */
+        axis2_status_t (AXIS2_CALL *
+                free)(
+                    axis2_ctx_t *ctx,
+                    const axis2_env_t *env);
+
+	/**
+	 * @param ctx pointer to context struct
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */ 
+        axis2_status_t (AXIS2_CALL *
+                set_non_persistent_map)(
+                    struct axis2_ctx *ctx,
+                    const axis2_env_t *env,
+                    axis2_hash_t* map);
+
+	/**
+	 * @param ctx pointer to context struct
+	 * @param env pointer to enviromnet struct
+	 * @param map pointer to map
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                set_persistent_map)(
+                    struct axis2_ctx *ctx,
+                    const axis2_env_t *env,
+                    axis2_hash_t* map);
+    };
+
     /**
-     * @param key
-     * @param persistent
-     * @return
+     * context struct
      */
-    axis2_property_t *(AXIS2_CALL *
-    get_property)(
-        struct axis2_ctx *ctx, 
-        const axis2_env_t *env, 
-        const axis2_char_t *key, 
-        const axis2_bool_t persistent);
-    
-    axis2_hash_t* (AXIS2_CALL *get_non_persistent_map)(struct axis2_ctx *ctx, 
-                                                           const axis2_env_t *env);
-    
-    axis2_hash_t* (AXIS2_CALL *get_persistent_map)(struct axis2_ctx *ctx, 
-                                                   const axis2_env_t *env);
-
-    /** 
-     * Deallocate memory
-     * @return status code
+    struct axis2_ctx
+    {
+	/** operations of context struct */
+        axis2_ctx_ops_t *ops;
+    };
+
+    /**
+     * Creates a context struct
+     * @param env pointer to environment struct
      */
-    axis2_status_t (AXIS2_CALL *free)(axis2_ctx_t *ctx,
-                                        const axis2_env_t *env); 
-    axis2_status_t (AXIS2_CALL *
-    set_non_persistent_map)(
-        struct axis2_ctx *ctx, 
-        const axis2_env_t *env,
-        axis2_hash_t* map);
-        
-    axis2_status_t (AXIS2_CALL *
-    set_persistent_map)(
-        struct axis2_ctx *ctx, 
-        const axis2_env_t *env,
-        axis2_hash_t* map);
-};
-
-/** 
- * @brief context struct
-  *   Axis2 context
- */
-struct axis2_ctx
-{
-    axis2_ctx_ops_t *ops;    
-};
+    AXIS2_EXTERN axis2_ctx_t *AXIS2_CALL 
+	    axis2_ctx_create(
+                const axis2_env_t *env);
 
-AXIS2_EXTERN axis2_ctx_t *AXIS2_CALL axis2_ctx_create (const axis2_env_t *env);
-    
 /************************** Start of function macros **************************/
 
+/** Set property.
+    @sa axis2_ctx_ops#set_property */
 #define AXIS2_CTX_SET_PROPERTY(ctx, env, key, value, persistent) \
     ((ctx)->ops->set_property(ctx, env, key, value, persistent))
+
+/** Get property.
+    @sa axis2_ctx_ops#get_property */
 #define AXIS2_CTX_GET_PROPERTY(ctx, env, key, persistent) \
     ((ctx)->ops->get_property(ctx, env, key, persistent))
+
+/** Get non persistant.
+    @sa axis2_ctx_ops#get_non_persistant_map */
 #define AXIS2_CTX_GET_NON_PERSISTANT_MAP(ctx, env) \
     ((ctx)->ops->get_non_persistent_map(ctx, env))
+
+/** Get persistant map.
+    @sa axis2_ctx_ops#get_persistant_map */
 #define AXIS2_CTX_GET_PERSISTANT_MAP(ctx, env) \
     ((ctx)->ops->get_persistent_map(ctx, env))
+
+/** Set non persistant map.
+    @sa axis2_ctx_ops#set_non_persistant_map */
 #define AXIS2_CTX_SET_NON_PERSISTANT_MAP(ctx, env, map) \
     ((ctx)->ops->set_non_persistent_map(ctx, env, map))
+
+/** set persistant map.
+    @sa axis2_ctx_ops#set_persistant_map */
 #define AXIS2_CTX_SET_PERSISTANT_MAP(ctx, env, map) \
     ((ctx)->ops->set_persistent_map(ctx, env, map))
+
+/** Frees the context.
+    @sa axis2_ctx_ops#free */
 #define AXIS2_CTX_FREE(ctx, env) \
     ((ctx)->ops->free (ctx, env))
 
-/************************** End of function macros ****************************/    
+/************************** End of function macros ****************************/
 
 /** @} */
 #ifdef __cplusplus



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