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/28 05:09:30 UTC
svn commit: r426367 - in /webservices/axis2/trunk/c/include:
axis2_http_transport_sender.h axis2_http_worker.h
Author: pini
Date: Thu Jul 27 20:09:29 2006
New Revision: 426367
URL: http://svn.apache.org/viewvc?rev=426367&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_http_transport_sender.h
webservices/axis2/trunk/c/include/axis2_http_worker.h
Modified: webservices/axis2/trunk/c/include/axis2_http_transport_sender.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_transport_sender.h?rev=426367&r1=426366&r2=426367&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_transport_sender.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_transport_sender.h Thu Jul 27 20:09:29 2006
@@ -17,12 +17,17 @@
#ifndef AXIS2_HTTP_TRANSPORT_SENDER_H
#define AXIS2_HTTP_TRANSPORT_SENDER_H
+/**
+ * @defgroup axis2_http_transport_sender http transport sender
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
/**
- * @file axis2_http_transport_sender.h
- * @brief axis2 HTTP Transport Sender (Handler) implementation
- */
-
+ * @file axis2_http_transport_sender.h
+ * @brief axis2 HTTP Transport Sender (Handler) implementation
+ */
+
#include <axis2_const.h>
#include <axis2_defines.h>
#include <axis2_env.h>
@@ -36,14 +41,12 @@
{
#endif
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
-
-
-AXIS2_EXTERN axis2_transport_sender_t * AXIS2_CALL
-axis2_http_transport_sender_create (const axis2_env_t *env);
+ /**
+ * @param env pointer to environment struct
+ */
+ AXIS2_EXTERN axis2_transport_sender_t * AXIS2_CALL
+ axis2_http_transport_sender_create (
+ const axis2_env_t *env);
/** @} */
Modified: webservices/axis2/trunk/c/include/axis2_http_worker.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_worker.h?rev=426367&r1=426366&r2=426367&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_worker.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_worker.h Thu Jul 27 20:09:29 2006
@@ -17,11 +17,16 @@
#ifndef AXIS2_HTTP_WORKER_H
#define AXIS2_HTTP_WORKER_H
+/**
+ * @defgroup axis2_http_worker http worker
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
/**
- * @file axis2_http_worker.h
- * @brief axis2 HTTP Worker
- */
+ * @file axis2_http_worker.h
+ * @brief axis2 HTTP Worker
+ */
#include <axis2_const.h>
#include <axis2_defines.h>
@@ -37,60 +42,91 @@
{
#endif
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
-
+ /** Type name for struct axis2_http_worker_ops */
typedef struct axis2_http_worker_ops axis2_http_worker_ops_t;
- typedef struct axis2_http_worker axis2_http_worker_t;
-
-/**
- * @brief HTTP Worker ops struct
- * Encapsulator struct for ops of axis2_http_worker
- */
-AXIS2_DECLARE_DATA struct axis2_http_worker_ops
-{
- axis2_bool_t (AXIS2_CALL *process_request)
- (axis2_http_worker_t *http_worker,
- const axis2_env_t *env,
- axis2_simple_http_svr_conn_t *svr_conn,
+ /** Type name for struct axis2_http_worker */
+ typedef struct axis2_http_worker axis2_http_worker_t;
+
+ /**
+ * HTTP Worker ops struct
+ * Encapsulator struct for ops of axis2_http_worker
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_worker_ops
+ {
+ /**
+ * @param http_worker pointer to http worker
+ * @param env pointer to environment struct
+ * @param svr_conn pointer to svr conn
+ * @param simple_request pointer to simple request
+ */
+ axis2_bool_t (AXIS2_CALL *
+ process_request)(
+ axis2_http_worker_t *http_worker,
+ const axis2_env_t *env,
+ axis2_simple_http_svr_conn_t *svr_conn,
axis2_http_simple_request_t *simple_request);
-
- axis2_status_t (AXIS2_CALL *set_svr_port)
- (axis2_http_worker_t *http_worker,
+
+ /**
+ * @param http_worker pointer to http worker
+ * @param env pointer to environment struct
+ * @param port
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ set_svr_port)(
+ axis2_http_worker_t *http_worker,
const axis2_env_t *env,
int port);
- axis2_status_t (AXIS2_CALL *free)
- (axis2_http_worker_t *http_worker,
- const axis2_env_t *env);
-};
-/**
- * @brief HTTP Worker struct
- * Axis2 HTTP Worker
- */
-AXIS2_DECLARE_DATA struct axis2_http_worker
-{
- axis2_http_worker_ops_t *ops;
-};
+ /**
+ * @param http_worker pointer to http worker
+ * @param env pointer to environment strut
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ axis2_http_worker_t *http_worker,
+ const axis2_env_t *env);
+ };
+ /**
+ * axis2 http worker
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_worker
+ {
+ /** operations of axis2 http worker */
+ axis2_http_worker_ops_t *ops;
+ };
+
+
+ /**
+ * @param env pointer to environment struct
+ * @param conf_ctx pointer to configuration context
+ */
+ AXIS2_EXTERN axis2_http_worker_t * AXIS2_CALL
+ axis2_http_worker_create (
+ const axis2_env_t *env,
+ axis2_conf_ctx_t *conf_ctx);
-AXIS2_EXTERN axis2_http_worker_t * AXIS2_CALL
-axis2_http_worker_create (const axis2_env_t *env, axis2_conf_ctx_t *conf_ctx);
-
/************************** Start of function macros **************************/
-
+/** Process the request.
+ @sa axis2_http_worker_ops#process_request */
#define AXIS2_HTTP_WORKER_PROCESS_REQUEST(http_worker, env, svr_conn,\
simple_request) ((http_worker)->ops->process_request(\
http_worker, env, svr_conn, simple_request))
+
+/** Sets the server port.
+ @sa axis2_http_worker_ops#set_svr_port */
#define AXIS2_HTTP_WORKER_SET_SVR_PORT(http_worker, env, port) \
((http_worker)->ops->set_svr_port(http_worker, env, port))
+
+/** Frees the http worker.
+ @sa axis2_http_worker_ops#free */
#define AXIS2_HTTP_WORKER_FREE(http_worker, env) \
((http_worker)->ops->free(http_worker, 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