diff options
author | m0gg | 2006-12-13 08:18:53 +0000 |
---|---|---|
committer | m0gg | 2006-12-13 08:18:53 +0000 |
commit | a24d40afbeb977745649dc84af82282535f14d24 (patch) | |
tree | 269fe6d5ad2cc91f342634652291c7bf6a28c3ee | |
parent | 05dc15bed267898a5db7792a673f26f4d6df0776 (diff) | |
download | csoap-a24d40afbeb977745649dc84af82282535f14d24.tar.gz csoap-a24d40afbeb977745649dc84af82282535f14d24.tar.bz2 |
Documentation fix
-rw-r--r-- | libcsoap/soap-server.h | 22 | ||||
-rw-r--r-- | nanohttp/nanohttp-base64.h | 6 | ||||
-rw-r--r-- | nanohttp/nanohttp-client.h | 17 | ||||
-rw-r--r-- | nanohttp/nanohttp-common.h | 6 |
4 files changed, 26 insertions, 25 deletions
diff --git a/libcsoap/soap-server.h b/libcsoap/soap-server.h index 23db560..2b3d9c0 100644 --- a/libcsoap/soap-server.h +++ b/libcsoap/soap-server.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: soap-server.h,v 1.23 2006/12/12 07:36:58 m0gg Exp $ + * $Id: soap-server.h,v 1.24 2006/12/13 08:18:53 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C * Copyright (C) 2003 Ferhat Ayaz @@ -36,15 +36,14 @@ * * @section project_features_sec Features * - * - @subpage csoap_page - * - SOAP 1.1 compliant - * - Platform independent: Windows, Unix, Linux, MacOS, OpenVMS - * - different transport services - * - @subpage nanohttp_page (HTTP including SSL) + * - SOAP 1.1 compliant (@subpage csoap_page) + * - supports different transport services + * - HTTP including SSL (@subpage nanohttp_page) * - client/server UDP transport service (multicast, SOAP-over-UDP) * - attachments via MIME * - message based security (XML encryption/signation) - * - automatic generation of WS-Inspection document + * - automatic generation of a WS-Inspection document + * - Platform independent: Windows, Unix, Linux, MacOS, OpenVMS * - Written in pure C. * * @section howto_sec HOWTOs and coding examples @@ -64,10 +63,11 @@ * * @section projects_sec Projects that use cSOAP * - * @subsection complearn_sec CompLearn (http://complearn.org/) + * @subsection complearn_sec CompLearn * - * CompLear is a suite of simple-to-use utilities that you can use to apply - * compression techniques to the process of discovering and learning patterns. + * CompLearn (http://complearn.org/) is a suite of simple-to-use utilities that + * you can use to apply compression techniques to the process of discovering and + * learning patterns. * * @section downloads_sec Downloads * @@ -111,7 +111,7 @@ * */ -/** @page csoap_page +/** @page csoap_page cSOAP * * T.B.D. * diff --git a/nanohttp/nanohttp-base64.h b/nanohttp/nanohttp-base64.h index 6556acf..03301ff 100644 --- a/nanohttp/nanohttp-base64.h +++ b/nanohttp/nanohttp-base64.h @@ -1,5 +1,5 @@ /****************************************************************** -* $Id: nanohttp-base64.h,v 1.3 2006/11/28 23:45:57 m0gg Exp $ +* $Id: nanohttp-base64.h,v 1.4 2006/12/13 08:18:53 m0gg Exp $ * * CSOAP Project: A http client/server library in C * Copyright (C) 2003 Ferhat Ayaz @@ -26,7 +26,7 @@ /** @file * - * Base64 data encoding + * \section base64_data_enc_sec Base64 data encoding * * Base encoding of data is used in many situations to store or transfer data in * environments that, perhaps for legacy reasons, are restricted to US-ASCII @@ -43,7 +43,7 @@ * characters. * * @author H. Ronsdorf - * @version $Revision: 1.3 $ + * @version $Revision: 1.4 $ * * @see http://www.ietf.org/rfc/rfc4648.txt * diff --git a/nanohttp/nanohttp-client.h b/nanohttp/nanohttp-client.h index 9422997..c86f98e 100644 --- a/nanohttp/nanohttp-client.h +++ b/nanohttp/nanohttp-client.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: nanohttp-client.h,v 1.35 2006/12/11 08:13:19 m0gg Exp $ + * $Id: nanohttp-client.h,v 1.36 2006/12/13 08:18:53 m0gg Exp $ * * CSOAP Project: A http client/server library in C * Copyright (C) 2003 Ferhat Ayaz @@ -111,7 +111,7 @@ * Please see @ref general_header_fields and @ref request_header_fields for more * information. * - * @subsection nanohttp_client_authorization_sec HTTP autorization + * @subsection nanohttp_client_authorization_sec HTTP authorization * * @code * httpc_set_basic_authorization(conn, "username", "password"); @@ -121,7 +121,7 @@ * httpc_set_basic_proxy_authorization(conn, "username", "password"); * @endcode * - * @section nanohttp_client_invoke_sec Fetch the network resource + * @section nanohttp_client_invoke_sec Request the network resource * * @subsection nanohttp_client_get_sec HTTP GET method * @@ -169,7 +169,7 @@ * * @ref nanohttp_mime_page * - * @section nanohttp_client_result_sec Print out the result + * @section nanohttp_client_result_sec Fetch and print out the result * * @code * while (http_input_stream_is_read(res->in)) @@ -215,21 +215,22 @@ extern "C" { /** * - * Initializes the httpc_* module. This is called from - * soap_client_init_args(). + * Initializes the nanoHTTP client module. * * @param argc Argument count. * @param argv Argument vector. * * @return H_OK on succes or a herror_t struct on failure. * - * @see httpc_destroy, herror_t, soap_client_init_args + * @see httpc_destroy + * @see herror_t + * */ extern herror_t httpc_init(int argc, char **argv); /** * - * Destroys the httpc_* module + * Destroys the nanoHTTP client module. * * @see httpc_init * diff --git a/nanohttp/nanohttp-common.h b/nanohttp/nanohttp-common.h index 03fe18d..27036a3 100644 --- a/nanohttp/nanohttp-common.h +++ b/nanohttp/nanohttp-common.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: nanohttp-common.h,v 1.44 2006/12/11 08:13:19 m0gg Exp $ + * $Id: nanohttp-common.h,v 1.45 2006/12/13 08:21:43 m0gg Exp $ * * CSOAP Project: A http client/server library in C * Copyright (C) 2003-2004 Ferhat Ayaz @@ -459,8 +459,8 @@ typedef enum _hreq_method * categorization role. There are 5 values for the first digit: * * - @ref status_informational_sec - Request received, continuing process - * - @ref status_success_sec - The action was successfully received, understood, - * and accepted + * - @ref status_successful_sec - The action was successfully received, + * understood, and accepted * - @ref status_redirection_sec - Further action must be taken in order to * complete the request * - @ref status_client_error_sec - The request contains bad syntax or cannot be |