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/14 09:07:06 UTC
svn commit: r421820 - /webservices/axis2/trunk/c/include/axis2_disp_checker.h
Author: pini
Date: Fri Jul 14 00:07:05 2006
New Revision: 421820
URL: http://svn.apache.org/viewvc?rev=421820&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_disp_checker.h
Modified: webservices/axis2/trunk/c/include/axis2_disp_checker.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_disp_checker.h?rev=421820&r1=421819&r2=421820&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_disp_checker.h (original)
+++ webservices/axis2/trunk/c/include/axis2_disp_checker.h Fri Jul 14 00:07:05 2006
@@ -1,23 +1,29 @@
/*
- * 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_DISP_CHECKER_H
#define AXIS2_DISP_CHECKER_H
/**
+ * @defgroup axis2_disp_checker dispatcher checker
+ * @ingroup axis2_engine
+ * @{
+ */
+
+/**
* @file axis2_disp_checker.h
* @brief Axis2 Dispatcher interface
*/
@@ -31,73 +37,101 @@
{
#endif
- struct axis2_disp_checker;
+ /** Type name for struct axis2_disp_checker_ops */
struct axis2_disp_checker_ops;
-
-/**
- * @defgroup axis2_disp_checker dispatcher checker
- * @ingroup axis2_engine
- * @{
- */
+ /** Type name for struct axis2_disp_checker */
+ struct axis2_disp_checker;
-/**
- * \brief Dispatcher ops struct
- */
- AXIS2_DECLARE_DATA typedef struct axis2_disp_checker_ops
- {
+ /**
+ * dispatcher checker ops struct
+ * Encapsulator struct for operations of axis2_disp_checker
+ */
+ AXIS2_DECLARE_DATA typedef struct axis2_disp_checker_ops
+ {
+ /**
+ * @param disp_checker pointer to dispatcher checker
+ * @param env pointer to environment struct
+ */
axis2_handler_t* (AXIS2_CALL *
- get_base) (struct axis2_disp_checker *disp_checker,
- const axis2_env_t *env);
-
-
+ get_base)(
+ struct axis2_disp_checker *disp_checker,
+ const axis2_env_t *env);
+
+
+ /**
+ * @param disp_checker pointer to dispatcher checker
+ * @param env pointer to environment struct
+ */
axis2_qname_t* (AXIS2_CALL *
- get_qname) (struct axis2_disp_checker *disp_checker,
+ get_qname)(
+ struct axis2_disp_checker *disp_checker,
const axis2_env_t *env);
-
+
+ /**
+ * @param disp_checker pointer to dispatcher checker
+ * @param env pointer to environment struct
+ * @param qname pointer to qname
+ */
axis2_status_t (AXIS2_CALL *
- set_qname) (struct axis2_disp_checker *disp_checker,
- const axis2_env_t *env,
- axis2_qname_t *qname);
-
+ set_qname)(
+ struct axis2_disp_checker *disp_checker,
+ const axis2_env_t *env,
+ axis2_qname_t *qname);
+
+ /**
+ * @param disp_checker pointer to dispatcher checker
+ * @param env pointer to environment struct
+ */
axis2_status_t (AXIS2_CALL *
- free) (struct axis2_disp_checker *disp_checker,
- const axis2_env_t *env);
-
- } axis2_disp_checker_ops_t;
-
- /**
- * \brief Dispatcher struct
- */
+ free) (struct axis2_disp_checker *disp_checker,
+ const axis2_env_t *env);
+
+ }
+ axis2_disp_checker_ops_t;
+
+ /**
+ * dispatcher checker struct
+ */
typedef struct axis2_disp_checker
{
- /** Dispatcher related ops */
+ /** operations of dispatcher checker */
axis2_disp_checker_ops_t *ops;
- } axis2_disp_checker_t;
+ }
+ axis2_disp_checker_t;
-/**
- * creates disp_checker struct
- * @param qname qname, can be NULL
- */
-AXIS2_EXTERN axis2_disp_checker_t* AXIS2_CALL
-axis2_disp_checker_create(const axis2_env_t *env,
- axis2_qname_t *qname);
+ /**
+ * Creates a dispatcher checker struct
+ * @param env pointer to environment struct
+ * @param qname pointer to qname, it can be NULL
+ */
+ AXIS2_EXTERN axis2_disp_checker_t* AXIS2_CALL
+ axis2_disp_checker_create(const axis2_env_t *env,
+ axis2_qname_t *qname);
+/** Gets the base.
+ @sa axis2_disp_checker_ops#get_base */
#define AXIS2_DISP_CHECKER_GET_BASE(disp_checker, env) \
((disp_checker)->ops->get_base(disp_checker, env))
-
+
+/** Gets the qname.
+ @sa axis2_disp_checker_ops#get_qname */
#define AXIS2_DISP_CHECKER_GET_QNAME(disp_checker, env) \
((disp_checker)->ops->get_qname(disp_checker, env))
-
+
+/** Sets the qname.
+ @sa axis2_disp_checker_ops#set_qname */
#define AXIS2_DISP_CHECKER_SET_QNAME(disp_checker, env, name) \
((disp_checker)->ops->set_qname(disp_checker, env, name))
-
+
+/** Frees the dispatcher checker.
+ @sa axis2_disp_checker_ops#free */
#define AXIS2_DISP_CHECKER_FREE(disp_checker, env) \
((disp_checker)->ops->free(disp_checker, env))
-
-
+
+
/** @} */
-
+
#ifdef __cplusplus
}
#endif
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org