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/27 11:34:34 UTC
svn commit: r426018 -
/webservices/axis2/trunk/c/include/axis2_http_request_line.h
Author: pini
Date: Thu Jul 27 02:34:34 2006
New Revision: 426018
URL: http://svn.apache.org/viewvc?rev=426018&view=rev
Log:
Updated doxygen comments to clean doc structure
Modified:
webservices/axis2/trunk/c/include/axis2_http_request_line.h
Modified: webservices/axis2/trunk/c/include/axis2_http_request_line.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_request_line.h?rev=426018&r1=426017&r2=426018&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_request_line.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_request_line.h Thu Jul 27 02:34:34 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_HTTP_REQUEST_LINE_H
#define AXIS2_HTTP_REQUEST_LINE_H
/**
+ * @defgroup axis2_http_request_line http request line
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
+
+/**
* @file axis2_http_request_line.h
* @brief axis2 HTTP Request Line
*/
@@ -28,74 +34,124 @@
#ifdef __cplusplus
-extern "C"
+extern "C"
{
#endif
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
-
-typedef struct axis2_http_request_line_ops axis2_http_request_line_ops_t;
-typedef struct axis2_http_request_line axis2_http_request_line_t;
-
-
-/**
- * @brief HTTP Request Line ops struct
- * Encapsulator struct for ops of axis2_http_request_line
- */
-AXIS2_DECLARE_DATA struct axis2_http_request_line_ops
-{
- axis2_char_t* (AXIS2_CALL *get_method)
- (axis2_http_request_line_t *request_line,
- const axis2_env_t *env);
-
- axis2_char_t* (AXIS2_CALL *get_http_version)
- (axis2_http_request_line_t *request_line,
- const axis2_env_t *env);
-
- axis2_char_t* (AXIS2_CALL *get_uri)
- (axis2_http_request_line_t *request_line,
- const axis2_env_t *env);
-
- axis2_char_t* (AXIS2_CALL *to_string)
- (axis2_http_request_line_t *request_line,
- const axis2_env_t *env);
-
- axis2_status_t (AXIS2_CALL *free)
- (axis2_http_request_line_t *request_line,
- const axis2_env_t *env);
-};
-
-/**
- * @brief HTTP Reqest Line struct
- * Axis2 HTTP Request Line
- */
-AXIS2_DECLARE_DATA struct axis2_http_request_line
-{
- axis2_http_request_line_ops_t *ops;
-};
-
-AXIS2_EXTERN axis2_http_request_line_t * AXIS2_CALL
-axis2_http_request_line_create(const axis2_env_t *env,
- const axis2_char_t *method,
- const axis2_char_t *uri,
- const axis2_char_t *http_version);
+ /** Type name for struct axis2_http_request_line_ops */
+ typedef struct axis2_http_request_line_ops axis2_http_request_line_ops_t;
+ /** Type name for struct axis2_http_request_line */
+ typedef struct axis2_http_request_line axis2_http_request_line_t;
+
+
+ /**
+ * HTTP Request Line ops struct
+ * Encapsulator struct for ops of axis2_http_request_line
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_request_line_ops
+ {
+ /**
+ * @param request_line pointer to request line
+ * @param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_method)(
+ axis2_http_request_line_t *request_line,
+ const axis2_env_t *env);
+
+ /**
+ * @param request_line pointer to request line
+ * @param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_http_version)(
+ axis2_http_request_line_t *request_line,
+ const axis2_env_t *env);
+
+ /**
+ * @param request_line pointer to request line
+ * @param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ get_uri)(
+ axis2_http_request_line_t *request_line,
+ const axis2_env_t *env);
+
+ /**
+ * @param request_line pointer to request line
+ * @param env pointer to environment struct
+ */
+ axis2_char_t* (AXIS2_CALL *
+ to_string)(
+ axis2_http_request_line_t *request_line,
+ const axis2_env_t *env);
+
+ /**
+ * @param request_line pointer to request line
+ * @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
+ axis2_status_t (AXIS2_CALL *
+ free)(
+ axis2_http_request_line_t *request_line,
+ const axis2_env_t *env);
+ };
+
+ /**
+ * @brief HTTP Reqest Line struct
+ * Axis2 HTTP Request Line
+ */
+ AXIS2_DECLARE_DATA struct axis2_http_request_line
+ {
+ axis2_http_request_line_ops_t *ops;
+ };
+
+ /**
+ * @param env pointer to environment struct
+ * @param method pointer to method
+ * @param uri pointer to uri
+ * @param http_version pointer to http version
+ */
+ AXIS2_EXTERN axis2_http_request_line_t * AXIS2_CALL
+ axis2_http_request_line_create(
+ const axis2_env_t *env,
+ const axis2_char_t *method,
+ const axis2_char_t *uri,
+ const axis2_char_t *http_version);
+
+ /**
+ * @param env pointer to environment struct
+ * @param str pointer to str
+ */
+ AXIS2_EXTERN axis2_http_request_line_t* AXIS2_CALL
+ axis2_http_request_line_parse_line(
+ const axis2_env_t *env,
+ const axis2_char_t *str);
-AXIS2_EXTERN axis2_http_request_line_t* AXIS2_CALL
-axis2_http_request_line_parse_line(const axis2_env_t *env, const axis2_char_t *str);
/********************* Start of function macros ***************************/
+/** Get method.
+ @sa axis2_http_request_line_ops#get_method */
#define AXIS2_HTTP_REQUEST_LINE_GET_METHOD(request_line, env) \
((request_line)->ops->get_method (request_line, env))
+
+/** Gets the http version.
+ @sa axis2_http_request_line_ops#get_http_version */
#define AXIS2_HTTP_REQUEST_LINE_GET_HTTP_VERSION(request_line, env) \
- ((request_line)->ops->get_http_version \
- (request_line, env))
+ ((request_line)->ops->get_http_version(request_line, env))
+
+/** Gets the uri.
+ @sa axis2_http_request_line_ops#get_uri */
#define AXIS2_HTTP_REQUEST_LINE_GET_URI(request_line, env) \
((request_line)->ops->get_uri (request_line, env))
+
+/** To string.
+ @sa axis2_http_request_line_ops#to_string */
#define AXIS2_HTTP_REQUEST_LINE_TO_STRING(request_line, env) \
((request_line)->ops->to_string (request_line, env))
+
+/** Frees the http request line.
+ @sa axis2_http_request_line_ops#free */
#define AXIS2_HTTP_REQUEST_LINE_FREE(request_line, env) \
((request_line)->ops->free(request_line, env))
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org