You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by pi...@apache.org on 2006/07/26 08:15:31 UTC
svn commit: r425641 - /webservices/axis2/trunk/c/include/axis2_phase_holder.h
Author: pini
Date: Tue Jul 25 23:15:31 2006
New Revision: 425641
URL: http://svn.apache.org/viewvc?rev=425641&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_phase_holder.h
Modified: webservices/axis2/trunk/c/include/axis2_phase_holder.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_phase_holder.h?rev=425641&r1=425640&r2=425641&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_phase_holder.h (original)
+++ webservices/axis2/trunk/c/include/axis2_phase_holder.h Tue Jul 25 23:15:31 2006
@@ -1,22 +1,28 @@
/*
- * 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_PHASE_HOLDER_H
#define AXIS2_PHASE_HOLDER_H
+/** @defgroup axis2_phase_holder phase holder
+ * @ingroup axis2_phase_resolver
+ * Description
+ * @{
+ */
+
/**
* @file axis2_phase_holder.h
* @brief Axis2 Wsdl soap op interface
@@ -39,121 +45,142 @@
{
#endif
-struct axis2_phase;
-struct axis2_handler_desc;
-struct axis2_handler;
-struct axis2_phase_rule;
-typedef struct axis2_phase_holder axis2_phase_holder_t;
-typedef struct axis2_phase_holder_ops axis2_phase_holder_ops_t;
+ struct axis2_phase;
+ struct axis2_handler_desc;
+ struct axis2_handler;
+ struct axis2_phase_rule;
+ /** Type name for struct axis2_phase_holder */
+ typedef struct axis2_phase_holder axis2_phase_holder_t;
+ /** Type name for struct axis2_phase_holder_ops */
+ typedef struct axis2_phase_holder_ops axis2_phase_holder_ops_t;
-/** @defgroup axis2_phase_holder phase holder
- * @ingroup axis2_phase_resolver
- * @{
- */
-
-/**
- * @brief Wsdl Phase Holder ops struct
- * Encapsulator struct for ops of axis2_phase_holder
- */
-AXIS2_DECLARE_DATA struct axis2_phase_holder_ops
-{
- /** De-allocate memory
- * @return status code
- */
- axis2_status_t (AXIS2_CALL *
- free)(axis2_phase_holder_t *phase_holder,
- const axis2_env_t *env);
-
/**
- * Method isPhaseExist
- *
- * @param phaseName
- * @return
+ * Wsdl Phase Holder ops struct
+ * Encapsulator struct for ops of axis2_phase_holder
*/
- axis2_bool_t (AXIS2_CALL *
- is_phase_exist)(axis2_phase_holder_t *phase_holder,
+ AXIS2_DECLARE_DATA struct axis2_phase_holder_ops
+ {
+ /** De-allocate memory
+ * @param phase_holder pointer to phase holder
+ * @param env pointer to environment struct
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ axis2_phase_holder_t *phase_holder,
+ const axis2_env_t *env);
+
+ /**
+ * Method isPhaseExist
+ * @param phase_holder pointer to phase holder
+ * @param env pointer to environment struct
+ * @param phase_name pointer to phase name
+ * @return
+ */
+ axis2_bool_t (AXIS2_CALL *
+ is_phase_exist)(
+ axis2_phase_holder_t *phase_holder,
const axis2_env_t *env,
axis2_char_t *phase_name);
-
- /**
- * Method addHandler
- *
- * @param handler
- */
- axis2_status_t (AXIS2_CALL *
- add_handler) (axis2_phase_holder_t *phase_holder,
- const axis2_env_t *env,
- struct axis2_handler_desc *handler);
-
- /**
- * this method is used to get the actual phase object given in the phase
- * array list
- * @param phaseName
- * @return
- */
- struct axis2_phase * (AXIS2_CALL *
- get_phase) (axis2_phase_holder_t *phase_holder,
- const axis2_env_t *env,
- axis2_char_t *phase_name);
-
- /**
- * This method is to build the transport phase , here load the corresponding
- * handlers and added them
- * in to correct phase
- *
- * @param phase
- * @param handlers
- */
- axis2_status_t (AXIS2_CALL *
- build_transport_handler_chain) (axis2_phase_holder_t *phase_holder,
- const axis2_env_t *env,
- struct axis2_phase *phase,
- axis2_array_list_t *handlers);
+ /**
+ * @param phase_holder pointer to phase holder
+ * @param env pointer to environment struct
+ * @para handler pointer to handler
+ */
+ axis2_status_t (AXIS2_CALL *
+ add_handler)(
+ axis2_phase_holder_t *phase_holder,
+ const axis2_env_t *env,
+ struct axis2_handler_desc *handler);
+ /**
+ * this method is used to get the actual phase object given in the phase
+ * array list
+ * @param phase_holder pointer to phase holder
+ * @param env pointer to environment struct
+ * @param phase_name pointer to phase name
+ */
+ struct axis2_phase * (AXIS2_CALL *
+ get_phase)(
+ axis2_phase_holder_t *phase_holder,
+ const axis2_env_t *env,
+ axis2_char_t *phase_name);
-};
+ /**
+ * This method is to build the transport phase , here load the corresponding
+ * handlers and added them
+ * in to correct phase
+ * @param phase_holder pointer to phase holder
+ * @param env pointer to environment struct
+ * @param phase pointer to phase
+ * @param handlers pointer to handlers
+ */
+ axis2_status_t (AXIS2_CALL *
+ build_transport_handler_chain)(
+ axis2_phase_holder_t *phase_holder,
+ const axis2_env_t *env,
+ struct axis2_phase *phase,
+ axis2_array_list_t *handlers);
-/**
- * @brief Phase Holder struct
- */
-AXIS2_DECLARE_DATA struct axis2_phase_holder
-{
- axis2_phase_holder_ops_t *ops;
-};
-/**
- * Creates phase holder struct
- * @return pointer to newly created phase holder
- */
-AXIS2_EXTERN axis2_phase_holder_t * AXIS2_CALL
-axis2_phase_holder_create (const axis2_env_t *env);
-/**
- * Creates phase holder struct
- * @param phases
- * @return pointer to newly created phase holder
- */
-AXIS2_EXTERN axis2_phase_holder_t * AXIS2_CALL
-axis2_phase_holder_create_with_phases (const axis2_env_t *env,
- axis2_array_list_t *phases);
+ };
+
+ /**
+ * phase holder struct
+ */
+ AXIS2_DECLARE_DATA struct axis2_phase_holder
+ {
+ /** operations of phase holder struct */
+ axis2_phase_holder_ops_t *ops;
+ };
+
+ /**
+ * Creates phase holder struct
+ * @param env pointer to environment struct
+ * @return pointer to newly created phase holder
+ */
+ AXIS2_EXTERN axis2_phase_holder_t * AXIS2_CALL
+ axis2_phase_holder_create (
+ const axis2_env_t *env);
+
+ /**
+ * Creates phase holder struct
+ * @param env pointer to environment struct
+ * @param phases pointer to phases
+ * @return pointer to newly created phase holder
+ */
+ AXIS2_EXTERN axis2_phase_holder_t * AXIS2_CALL
+ axis2_phase_holder_create_with_phases (
+ const axis2_env_t *env,
+ axis2_array_list_t *phases);
/*************************** Function macros **********************************/
+/** Frees the phase holder.
+ @sa axis2_phase_holder_ops#free */
#define AXIS2_PHASE_HOLDER_FREE(phase_holder, env) \
((phase_holder)->ops->free (phase_holder, env))
+/** Is phase exist.
+ @sa axis2_phase_holder_ops#is_phase_exist */
#define AXIS2_PHASE_HOLDER_IS_PHASE_EXIST(phase_holder, env, phase_name) \
((phase_holder)->ops->is_phase_exist (phase_holder, env, phase_name))
+/** Add handler.
+ @sa axis2_phase_holder_ops#add_handler */
#define AXIS2_PHASE_HOLDER_ADD_HANDLER(phase_holder, env, handler) \
((phase_holder)->ops->add_handler (phase_holder, env, handler))
+/** Gets the phase.
+ @sa axis2_phase_holder_ops#get_phase */
#define AXIS2_PHASE_HOLDER_GET_PHASE(phase_holder, env, phase_name) \
((phase_holder)->ops->get_phase (phase_holder, env, phase_name))
+/** Build transport handler chain.
+ @sa axis2_phase_holder_ops#build_transport_handler_chain */
#define AXIS2_PHASE_HOLDER_BUILD_TRANSPORT_HANDLER_CHAIN(phase_holder, env, phase, handlers) \
- ((phase_holder)->ops->build_transport_handler_chain (phase_holder, env, phase, handlers))
+ ((phase_holder)->ops->build_transport_handler_chain (phase_holder, env, phase, handlers))
/*************************** 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