You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by pi...@apache.org on 2006/07/26 10:39:37 UTC
svn commit: r425676 - in /webservices/axis2/trunk/c/include: axis2_desc.h
axis2_description.h axis2_phases_info.h
Author: pini
Date: Wed Jul 26 01:39:37 2006
New Revision: 425676
URL: http://svn.apache.org/viewvc?rev=425676&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_desc.h
webservices/axis2/trunk/c/include/axis2_description.h
webservices/axis2/trunk/c/include/axis2_phases_info.h
Modified: webservices/axis2/trunk/c/include/axis2_desc.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_desc.h?rev=425676&r1=425675&r2=425676&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_desc.h (original)
+++ webservices/axis2/trunk/c/include/axis2_desc.h Wed Jul 26 01:39:37 2006
@@ -51,6 +51,7 @@
/**
* @param desc pointer to desc
* @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
free)(
@@ -61,6 +62,7 @@
* @param desc pointer to desc
* @param env pointer to environment struct
* @param param pointer to param
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
add_param)(
@@ -114,6 +116,7 @@
* @param desc pointer to desc
* @param env pointer to environment struct
* @param key pointer to key
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
add_child)(
@@ -146,6 +149,7 @@
* @param desc pointer to desc
* @param env pointer to environment struct
* @param key pointer to key
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t (AXIS2_CALL *
remove_child)(
Modified: webservices/axis2/trunk/c/include/axis2_description.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_description.h?rev=425676&r1=425675&r2=425676&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_description.h (original)
+++ webservices/axis2/trunk/c/include/axis2_description.h Wed Jul 26 01:39:37 2006
@@ -1,19 +1,19 @@
/*
- * 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_DESCRIPTION_H
#define AXIS2_DESCRIPTION_H
@@ -21,7 +21,7 @@
* @file axis2_axis2_description.h
* @brief axis2 DESCRIPTION
*/
-
+
#include <axis2_const.h>
#include <axis2_error.h>
#include <axis2_defines.h>
@@ -31,17 +31,17 @@
#include <axis2_hash.h>
#ifdef __cplusplus
-extern "C"
+extern "C"
{
#endif
-/**
- * @defgroup axis2_desc description
- * @ingroup axis2
- * @{
- * @}
- */
-
+/**
+ * @defgroup axis2_desc description
+ * @ingroup axis2
+ * @{
+ * @}
+ */
+
/*********************************** Constansts********************************/
/**
@@ -105,9 +105,13 @@
#define AXIS2_OUTFLOW_KEY "OUTFLOW_KEY"
/**
- * Field FAULTFLOW_KEY
+ * Field IN_FAULTFLOW_KEY
*/
#define AXIS2_IN_FAULTFLOW_KEY "IN_FAULTFLOW_KEY"
+
+/**
+ * Field OUT_FAULTFLOW_KEY
+ */
#define AXIS2_OUT_FAULTFLOW_KEY "OUT_FAULTFLOW_KEY"
/**
@@ -125,10 +129,10 @@
*/
#define AXIS2_SERVICE_CLASS_NAME "SERVICE_CLASS_NAME"
-
-/*********************************** Constants*********************************/
-
-
+
+/*********************************** Constants*********************************/
+
+
#ifdef __cplusplus
}
#endif
Modified: webservices/axis2/trunk/c/include/axis2_phases_info.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_phases_info.h?rev=425676&r1=425675&r2=425676&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_phases_info.h (original)
+++ webservices/axis2/trunk/c/include/axis2_phases_info.h Wed Jul 26 01:39:37 2006
@@ -17,6 +17,12 @@
#ifndef AXIS2_PHASES_INFO_H
#define AXIS2_PHASES_INFO_H
+/** @defgroup axis2_phases_info phases information
+ * @ingroup axis2_engine
+ * Description
+ * @{
+ */
+
/**
* @file axis2_phases_info.h
* @brief axis2 phases info interface.
@@ -37,145 +43,250 @@
#endif
-typedef struct axis2_phases_info_ops axis2_phases_info_ops_t;
-typedef struct axis2_phases_info axis2_phases_info_t;
-
-/** @defgroup axis2_phases_info phases information
- * @ingroup axis2_phase_resolver
- * @{
- */
-
-/**
- * @brief Phases Info ops struct
- * Encapsulator struct for ops of axis2_phases_info
- */
-struct axis2_phases_info_ops
-{
- /** Deallocate memory
- * @return status code
+ /** Type name for struct axis2_phases_info_ops */
+ typedef struct axis2_phases_info_ops axis2_phases_info_ops_t;
+ /** Type name for struct axis2_phases_info */
+ typedef struct axis2_phases_info axis2_phases_info_t;
+
+ /**
+ * Phases Info ops struct
+ * Encapsulator struct for ops of axis2_phases_info
*/
- axis2_status_t (AXIS2_CALL *free) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *
- set_in_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env,
- axis2_array_list_t *in_phases);
-
- axis2_status_t (AXIS2_CALL *
- set_out_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env,
- axis2_array_list_t *out_phases);
-
- axis2_status_t (AXIS2_CALL *
- set_in_faultphases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env,
- axis2_array_list_t *in_faultphases);
-
- axis2_status_t (AXIS2_CALL *
- set_out_faultphases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env,
- axis2_array_list_t * out_faultphases);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_in_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_out_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_in_faultphases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_out_faultphases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_op_in_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_op_out_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_op_in_faultphases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_array_list_t *(AXIS2_CALL *
- get_op_out_faultphases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *
- set_op_phases) (axis2_phases_info_t *phases_info,
- const axis2_env_t *env,
- struct axis2_op *axis2_opt);
-
-
-};
+ struct axis2_phases_info_ops
+ {
+ /** Deallocate memory
+ * @param pahses_info pointer to phases info
+ * @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ * @param in_phases inter to in phases
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_in_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env,
+ axis2_array_list_t *in_phases);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ * @param out_phases pointer to out phases
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_out_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env,
+ axis2_array_list_t *out_phases);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ * @param in_faultphases pionter to in fault phases
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_in_faultphases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env,
+ axis2_array_list_t *in_faultphases);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to env
+ * @param out_faultphases pointer to out fault phases
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_out_faultphases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env,
+ axis2_array_list_t * out_faultphases);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_in_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_out_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @parma env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_in_faultphases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_out_faultphases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_op_in_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_op_out_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_op_in_faultphases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ */
+ axis2_array_list_t *(AXIS2_CALL *
+ get_op_out_faultphases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env);
+
+ /**
+ * @param phases_info pointer to phases info
+ * @param env pointer to environment struct
+ * @param axis2_opt pointer to axis2 opt
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_op_phases)(
+ axis2_phases_info_t *phases_info,
+ const axis2_env_t *env,
+ struct axis2_op *axis2_opt);
-/**
- * @brief Phases Info struct
- * Axis2 Phases Info
- */
-struct axis2_phases_info
-{
- axis2_phases_info_ops_t *ops;
-};
+ };
-/** create Phases Info struct
- * @return pointer to newly created phases info
- */
-AXIS2_EXTERN axis2_phases_info_t * AXIS2_CALL
-axis2_phases_info_create (const axis2_env_t *env);
+ /**
+ * phases info struct
+ */
+ struct axis2_phases_info
+ {
+ /** operations of phases info struct */
+ axis2_phases_info_ops_t *ops;
+ };
+
+ /** create Phases Info struct
+ * @param env pointer to environment struct
+ * @return pointer to newly created phases info
+ */
+ AXIS2_EXTERN axis2_phases_info_t * AXIS2_CALL
+ axis2_phases_info_create (
+ const axis2_env_t *env);
/**************************** Start of function macros ************************/
+/** Frees the phases info.
+ @sa axis2_phases_info_ops#free */
#define AXIS2_PHASES_INFO_FREE(phases_info, env) \
((phases_info)->ops->free (phases_info, env))
+/** Sets the in phases.
+ @sa axis2_phases_info_ops#set_in_phases */
#define AXIS2_PHASES_INFO_SET_IN_PHASES(phases_info, env, in_phases) \
((phases_info)->ops->set_in_phases(phases_info, env, in_phases))
-
+
+/** Sets the out phases.
+ @sa axis2_phases_info_ops#set_out_phases */
#define AXIS2_PHASES_INFO_SET_OUT_PHASES(phases_info, env, out_phases) \
((phases_info)->ops->set_out_phases(phases_info, env, out_phases))
+/** Sets the in fault phases.
+ @sa axis2_phases_info_ops#set_in_faultphases */
#define AXIS2_PHASES_INFO_SET_IN_FAULTPHASES(phases_info, env, in_faultphases) \
((phases_info)->ops->set_in_faultphases(phases_info, env, in_faultphases))
+/** Sets the out fault phases.
+ @sa axis2_phases_info_ops#set_out_faultphases */
#define AXIS2_PHASES_INFO_SET_OUT_FAULTPHASES(phases_info, env, out_faultphases) \
- ((phases_info)->ops->set_out_faultphases(phases_info, env, out_faultphases))
+ ((phases_info)->ops->set_out_faultphases(phases_info, env, out_faultphases))
+/** Gets the in phases.
+ @sa axis2_phases_info_ops#get_in_phases */
#define AXIS2_PHASES_INFO_GET_IN_PHASES(phases_info, env) \
- ((phases_info)->ops->get_in_phases(phases_info, env))
+ ((phases_info)->ops->get_in_phases(phases_info, env))
+/** Gets the out phases.
+ @sa axis2_phases_info_ops#get_out_phases */
#define AXIS2_PHASES_INFO_GET_OUT_PHASES(phases_info, env) \
- ((phases_info)->ops->get_out_phases(phases_info, env))
-
+ ((phases_info)->ops->get_out_phases(phases_info, env))
+
+/** Gets the in fault phases.
+ @sa axis2_phases_info_ops#get_in_faultphases */
#define AXIS2_PHASES_INFO_GET_IN_FAULTPHASES(phases_info, env) \
- ((phases_info)->ops->get_in_faultphases(phases_info, env))
+ ((phases_info)->ops->get_in_faultphases(phases_info, env))
+/** Gets the out fault phases.
+ @sa axis2_phases_info_ops#get_out_faultphases */
#define AXIS2_PHASES_INFO_GET_OUT_FAULTPHASES(phases_info, env) \
- ((phases_info)->ops->get_out_faultphases(phases_info, env))
-
+ ((phases_info)->ops->get_out_faultphases(phases_info, env))
+
+/** Gets the op in phases.
+ @sa axis2_phases_info_ops#get_op_in_phases */
#define AXIS2_PHASES_INFO_GET_OP_IN_PHASES(phases_info, env) \
- ((phases_info)->ops->get_op_in_phases(phases_info, env))
+ ((phases_info)->ops->get_op_in_phases(phases_info, env))
+/** Gets the op out phases.
+ @sa axis2_phases_info_ops#get_op_out_phases */
#define AXIS2_PHASES_INFO_GET_OP_OUT_PHASES(phases_info, env) \
- ((phases_info)->ops->get_op_out_phases(phases_info, env))
-
+ ((phases_info)->ops->get_op_out_phases(phases_info, env))
+
+/** Gets the op in fault phases.
+ @sa axis2_phases_info_ops#get_op_in_faultphases */
#define AXIS2_PHASES_INFO_GET_OP_IN_FAULTPHASES(phases_info, env) \
- ((phases_info)->ops->get_op_in_faultphases(phases_info, env))
-
+ ((phases_info)->ops->get_op_in_faultphases(phases_info, env))
+
+/** Gets the op out fault phases.
+ @sa axis2_phases_info_ops#get_op_out_faultphases */
#define AXIS2_PHASES_INFO_GET_OP_OUT_FAULTPHASES(phases_info, env) \
- ((phases_info)->ops->get_op_out_faultphases(phases_info, env))
-
+ ((phases_info)->ops->get_op_out_faultphases(phases_info, env))
+
+/** Sets the op phases.
+ @sa axis2_phases_info_ops#set_op_phases */
#define AXIS2_PHASES_INFO_SET_OP_PHASES(phases_info, env, axis2_opt) \
- ((phases_info)->ops->set_op_phases(phases_info, env, axis2_opt))
-
+ ((phases_info)->ops->set_op_phases(phases_info, env, axis2_opt))
+
/**************************** End of function macros **************************/
/** @} */
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org