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/27 16:18:06 UTC

svn commit: r426085 - /webservices/axis2/trunk/c/include/axis2_http_response_writer.h

Author: pini
Date: Thu Jul 27 07:18:05 2006
New Revision: 426085

URL: http://svn.apache.org/viewvc?rev=426085&view=rev
Log:
Updated doxygen comments to clean doc structure


Modified:
    webservices/axis2/trunk/c/include/axis2_http_response_writer.h

Modified: webservices/axis2/trunk/c/include/axis2_http_response_writer.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_response_writer.h?rev=426085&r1=426084&r2=426085&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_response_writer.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_response_writer.h Thu Jul 27 07:18:05 2006
@@ -1,28 +1,33 @@
 /*
- * 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_RESPONSE_WRITER_H
 #define AXIS2_HTTP_RESPONSE_WRITER_H
 
+/**
+ * @defgroup axis2_http_response_writer http response writer 
+ * @ingroup axis2_core_trans_http
+ * @{
+ */
 
 /**
-  * @file axis2_http_response_writer.h
-  * @brief axis2 Response Writer
-  */
-  
+ * @file axis2_http_response_writer.h
+ * @brief axis2 Response Writer
+ */
+
 #include <axis2_const.h>
 #include <axis2_defines.h>
 #include <axis2_env.h>
@@ -33,109 +38,217 @@
 {
 #endif
 
-/**
- * @ingroup axis2_core_transport_http
- * @{
- */
-
-    typedef struct axis2_http_response_writer_ops 
-                                        axis2_http_response_writer_ops_t;
+    /** Type name for struct axis2_http_response_writer_ops */
+    typedef struct axis2_http_response_writer_ops axis2_http_response_writer_ops_t;
+    /** Type name for struct axis2_http_response_writer */
     typedef struct axis2_http_response_writer axis2_http_response_writer_t;
 
-    
-/** 
- * @brief HTTP Response Writer ops struct
- * Encapsulator struct for ops of axis2_http_response_writer
- */  
-AXIS2_DECLARE_DATA struct axis2_http_response_writer_ops
-{
-    axis2_char_t* (AXIS2_CALL *get_encoding) 
-                    (axis2_http_response_writer_t *response_writer, 
+
+    /**
+     * HTTP Response Writer ops struct
+     * Encapsulator struct for ops of axis2_http_response_writer
+     */
+    AXIS2_DECLARE_DATA struct axis2_http_response_writer_ops
+    {
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 */
+        axis2_char_t* (AXIS2_CALL *
+                get_encoding)(
+                    axis2_http_response_writer_t *response_writer,
                     const axis2_env_t *env);
-    
-    axis2_status_t (AXIS2_CALL *close) 
-                    (axis2_http_response_writer_t *response_writer, 
+
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                close)(
+                    axis2_http_response_writer_t *response_writer,
                     const axis2_env_t *env);
-    
-    axis2_status_t (AXIS2_CALL *flush) 
-                    (axis2_http_response_writer_t *response_writer, 
+
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL * 
+                flush)(
+                    axis2_http_response_writer_t *response_writer,
                     const axis2_env_t *env);
-    
-    axis2_status_t (AXIS2_CALL *write_char) 
-                    (axis2_http_response_writer_t *response_writer, 
-                    const axis2_env_t *env, char c);
-    
-    axis2_status_t (AXIS2_CALL *write_buf) 
-                    (axis2_http_response_writer_t *response_writer, 
-                    const axis2_env_t *env, char *buf, int offset, 
-                    axis2_ssize_t len);
 
-    axis2_status_t (AXIS2_CALL *print_str) 
-                    (axis2_http_response_writer_t *response_writer, 
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @param c
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL * 
+                write_char)(
+                    axis2_http_response_writer_t *response_writer,
+                    const axis2_env_t *env, 
+		    char c);
+
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @param buf pointer to buf
+	 * @param offset
+	 * @param len
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                write_buf)(
+                    axis2_http_response_writer_t *response_writer,
                     const axis2_env_t *env, 
+		    char *buf, 
+		    int offset,
+                    axis2_ssize_t len);
+
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @param str pointer to str
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                print_str)(
+                    axis2_http_response_writer_t *response_writer,
+                    const axis2_env_t *env,
                     const char *str);
-    
-    axis2_status_t (AXIS2_CALL *print_int) 
-                    (axis2_http_response_writer_t *response_writer, 
-                    const axis2_env_t *env, int i);
-    
-    axis2_status_t (AXIS2_CALL *println_str) 
-                    (axis2_http_response_writer_t *response_writer, 
+
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @param i
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                print_int)(
+                    axis2_http_response_writer_t *response_writer,
                     const axis2_env_t *env, 
+		    int i);
+
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @param str pointer to str
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                println_str)(
+                    axis2_http_response_writer_t *response_writer,
+                    const axis2_env_t *env,
                     const char *str);
-    
-    axis2_status_t (AXIS2_CALL *println) 
-                    (axis2_http_response_writer_t *response_writer, 
-                    const axis2_env_t *env);
-    
-    axis2_status_t (AXIS2_CALL *free) 
-                    (axis2_http_response_writer_t *response_writer, 
-                    const axis2_env_t *env);
-};
 
-/** 
- * @brief HTTP Response Writer struct
- *    Axis2 HTTP Response Writer
- */
-AXIS2_DECLARE_DATA struct axis2_http_response_writer
-{
-    axis2_http_response_writer_ops_t *ops;    
-};
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                println)(
+                    axis2_http_response_writer_t *response_writer,
+                    const axis2_env_t *env);
 
+        /**
+	 * @param response_writer pointer to response writer
+	 * @param env pointer to environment struct
+	 * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+	 */
+        axis2_status_t (AXIS2_CALL *
+                free)(
+                    axis2_http_response_writer_t *response_writer,
+                    const axis2_env_t *env);
+    };
 
-AXIS2_EXTERN axis2_http_response_writer_t * AXIS2_CALL 
-axis2_http_response_writer_create (const axis2_env_t *env, axis2_stream_t *stream);
+    /**
+     * axis2 http response writer
+     */
+    AXIS2_DECLARE_DATA struct axis2_http_response_writer
+    {
+        /** operations of axis2 http response writer */
+        axis2_http_response_writer_ops_t *ops;
+    };
+
+
+    /**
+     * @param env pointer to environment struct
+     * @param stream pointer to stream
+     */
+    AXIS2_EXTERN axis2_http_response_writer_t * AXIS2_CALL
+    axis2_http_response_writer_create (
+        const axis2_env_t *env, 
+	axis2_stream_t *stream);
+
+    /**
+     * @param env pointer to environment struct
+     * @param stream pointer to stream
+     * @param encoding pointer to encoding
+     */
+    AXIS2_EXTERN axis2_http_response_writer_t * AXIS2_CALL
+    axis2_http_response_writer_create_with_encoding(
+        const axis2_env_t *env,
+        axis2_stream_t *stream, 
+	const axis2_char_t *encoding);
 
-AXIS2_EXTERN axis2_http_response_writer_t * AXIS2_CALL 
-axis2_http_response_writer_create_with_encoding(const axis2_env_t *env,
-                    axis2_stream_t *stream, const axis2_char_t *encoding);
-    
 /************************** Start of function macros **************************/
 
+/** Get encoding.
+    @sa axis2_http_response_writer_ops#get_encoding */
 #define AXIS2_HTTP_RESPONSE_WRITER_GET_ENCODING(response_writer, env) \
                     ((response_writer)->ops->get_encoding(response_writer, env))
+
+/** Close.
+    @sa axis2_http_response_writer_ops#close */
 #define AXIS2_HTTP_RESPONSE_WRITER_CLOSE(response_writer, env) \
                     ((response_writer)->ops->close(response_writer, env))
+
+/** Flush.
+    @sa axis2_http_response_writer_ops#flush */
 #define AXIS2_HTTP_RESPONSE_WRITER_FLUSH(response_writer, env) \
                     ((response_writer)->ops->flush(response_writer, env))
+
+/** Write char.
+    @sa axis2_http_response_writer_ops#write_char */
 #define AXIS2_HTTP_RESPONSE_WRITER_WRITE_CHAR(response_writer, env, c) \
                     ((response_writer)->ops->write_char(response_writer, env, c))
+
+/** Write buf.
+    @sa axis2_http_response_writer_ops#write_buf */
 #define AXIS2_HTTP_RESPONSE_WRITER_WRITE_BUF(response_writer, env, buf, offset,\
                     len) ((response_writer)->ops->write_buf(response_writer, \
                     env, buf, offset, len))
+
+/** Print str.
+    @sa axis2_http_response_writer_ops#print_str */
 #define AXIS2_HTTP_RESPONSE_WRITER_PRINT_STR(response_writer, env, str) \
                     ((response_writer)->ops->print_str(response_writer, env, str))
+
+/** Print int.
+    @sa axis2_http_response_writer_ops#print_int */
 #define AXIS2_HTTP_RESPONSE_WRITER_PRINT_INT(response_writer, env, i)\
                     ((response_writer)->ops->print_int(response_writer, env))
+
+/** Println str.
+    @sa axis2_http_response_writer_ops#println_str */
 #define AXIS2_HTTP_RESPONSE_WRITER_PRINTLN_STR(response_writer, env, str) \
                     ((response_writer)->ops->println_str(response_writer, env,\
                     str))
+
+/** Println.
+    @sa axis2_http_response_writer_ops#println */
 #define AXIS2_HTTP_RESPONSE_WRITER_PRINTLN(response_writer, env) \
                     ((response_writer)->ops->println(response_writer, env))
+
+/** Frees the http response writer.
+    @sa axis2_http_response_writer_ops#free */
 #define AXIS2_HTTP_RESPONSE_WRITER_FREE(response_writer, env)\
                     ((response_writer)->ops->free(response_writer, 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