Author: samisa
Date: Mon Aug 21 03:50:04 2006
New Revision: 433221
URL: http://svn.apache.org/viewvc?rev=433221&view=rev
Log:
More doc comment and API fixes
Modified:
webservices/axis2/trunk/c/include/axis2_flow.h
webservices/axis2/trunk/c/modules/core/description/flow.c
Modified: webservices/axis2/trunk/c/include/axis2_flow.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_flow.h?rev=433221&r1=433220&r2=433221&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_flow.h (original)
+++ webservices/axis2/trunk/c/include/axis2_flow.h Mon Aug 21 03:50:04 2006
@@ -20,13 +20,13 @@
/**
* @defgroup axis2_flow flow
* @ingroup axis2_desc
- * Description.
+ * flow is a collection of handlers. This struct encapsulates the concept
+ * of an execution flow in the engine.
* @{
*/
/**
* @file axis2_flow.h
- * @brief axis2 flow interface
*/
#include <axis2_const.h>
@@ -51,13 +51,13 @@
/**
- * Flow ops struct
- * Encapsulator struct for ops of axis2_flow
+ * flow ops struct.
+ * Encapsulator struct for ops of axis2_flow.
*/
struct axis2_flow_ops
{
/**
- * Deallocate memory
+ * Frees flow struct.
* @param flow pointer to flow
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
@@ -68,10 +68,10 @@
const axis2_env_t *env);
/**
- * Add handler description
+ * Adds a handler description to flow.
* @param flow pointer to flow
* @param env pointer to environment struct
- * @param handler handler description
+ * @param handler pointer to handler description
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
@@ -81,20 +81,20 @@
axis2_handler_desc_t *handler);
/**
- * Get handler
+ * Gets handler description at given index.
* @param flow pointer to flow
* @param env pointer to environment struct
* @param index index of the handler
- * @return handler description
+ * @return pointer to handler description
*/
axis2_handler_desc_t *(AXIS2_CALL *
get_handler)(
const axis2_flow_t *flow,
const axis2_env_t *env,
- int index);
+ const int index);
/**
- * Get handler count
+ * Gets handler count.
* @param flow pointer to flow
* @param env pointer to environment struct
* @return handler count
@@ -106,7 +106,7 @@
};
/**
- * Flow struct
+ * flow struct.
*/
struct axis2_flow
{
@@ -115,7 +115,7 @@
};
/**
- * Creates flow struct
+ * Creates flow struct.
* @param env pointer to environment struct
* @return pointer to newly created flow
*/
@@ -124,39 +124,36 @@
const axis2_env_t *env);
/**
- * Free flow passed as void pointer. This will be
- * cast into appropriate type and then pass the cast object
- * into the flow structure's free method
+ * Frees flow passed as void pointer. This method would cast the void
+ * pointer to appropriate type and then call free method.
* @param flow pointer to flow
* @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_flow_free_void_arg (
void *flow,
const axis2_env_t *env);
-/*************************** Function macros **********************************/
-/** Frees the flow.
+/** Frees flow.
@sa axis2_flow_ops#free */
#define AXIS2_FLOW_FREE(flow, env) ((flow)->ops->free (flow, env))
-/** Adds the handler.
+/** Adds handler.
@sa axis2_flow_ops#add_handler */
#define AXIS2_FLOW_ADD_HANDLER(flow, env, handler) \
((flow)->ops->add_handler (flow, env, handler))
-/** Gets the handler.
+/** Gets handler at given index.
@sa axis2_flow_ops#get_handler */
#define AXIS2_FLOW_GET_HANDLER(flow, env, index) \
((flow)->ops->get_handler (flow, env, index))
-/** Gets the handler count.
+/** Gets handler count.
@sa axis2_flow_ops#get_handler_count */
#define AXIS2_FLOW_GET_HANDLER_COUNT(flow, env) \
((flow)->ops->get_handler_count (flow, env))
-
-/*************************** End of function macros ***************************/
/** @} */
Modified: webservices/axis2/trunk/c/modules/core/description/flow.c
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/modules/core/description/flow.c?rev=433221&r1=433220&r2=433221&view=diff
==============================================================================
--- webservices/axis2/trunk/c/modules/core/description/flow.c (original)
+++ webservices/axis2/trunk/c/modules/core/description/flow.c Mon Aug 21 03:50:04 2006
@@ -16,25 +16,15 @@
#include <axis2_flow.h>
-/**
- * @brief Flow struct impl
- * Axis2 Flow impl
- */
typedef struct axis2_flow_impl
{
axis2_flow_t flow;
- /**
- * Field list
- */
+
axis2_array_list_t *list;
-
-}
-axis2_flow_impl_t;
+} axis2_flow_impl_t;
#define AXIS2_INTF_TO_IMPL(flow) ((axis2_flow_impl_t *)(flow))
-/***************************** Function headers *******************************/
-
axis2_status_t AXIS2_CALL
axis2_flow_free(
axis2_flow_t *flow,
@@ -50,15 +40,13 @@
axis2_flow_get_handler(
const axis2_flow_t *flow,
const axis2_env_t *env,
- int index);
+ const int index);
int AXIS2_CALL
axis2_flow_get_handler_count(
const axis2_flow_t *flow,
const axis2_env_t *env);
-/************************** End of Function headers ************************/
-
AXIS2_EXTERN axis2_flow_t *AXIS2_CALL
axis2_flow_create(
const axis2_env_t *env)
@@ -78,8 +66,7 @@
flow_impl->list = NULL;
flow_impl->flow.ops = NULL;
- /*Create the list with the default size of 16 */
- flow_impl->list = axis2_array_list_create (env, 20);
+ flow_impl->list = axis2_array_list_create (env, 20);
if(NULL == flow_impl->list)
{
axis2_flow_free(&(flow_impl->flow), env);
@@ -96,7 +83,7 @@
return NULL;
}
- flow_impl->flow.ops->free = axis2_flow_free;
+ flow_impl->flow.ops->free = axis2_flow_free;
flow_impl->flow.ops->add_handler = axis2_flow_add_handler;
flow_impl->flow.ops->get_handler = axis2_flow_get_handler;
flow_impl->flow.ops->get_handler_count = axis2_flow_get_handler_count;
@@ -104,8 +91,6 @@
return &(flow_impl->flow);
}
-/*************************** Start of op impls *************************/
-
axis2_status_t AXIS2_CALL
axis2_flow_free(
axis2_flow_t *flow,
@@ -191,7 +176,7 @@
axis2_flow_get_handler(
const axis2_flow_t *flow,
const axis2_env_t *env,
- int index)
+ const int index)
{
AXIS2_ENV_CHECK(env, NULL);
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org
|