From c1a7b2dabdc691139b744f0d4750f3b797b69073 Mon Sep 17 00:00:00 2001 From: m0gg Date: Thu, 25 Jan 2007 10:24:10 +0000 Subject: Documentation cleanup --- libcsoap/soap-server.h | 11 ++++++----- libcsoap/soap-xmlsec.h | 6 +++--- nanohttp/nanohttp-server.h | 11 +++++------ nanohttp/nanohttp-ssl.h | 41 ++++++++++++++++++++++------------------- 4 files changed, 36 insertions(+), 33 deletions(-) diff --git a/libcsoap/soap-server.h b/libcsoap/soap-server.h index 7e4a6ec..a97da1c 100644 --- a/libcsoap/soap-server.h +++ b/libcsoap/soap-server.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: soap-server.h,v 1.26 2007/01/03 13:46:32 m0gg Exp $ + * $Id: soap-server.h,v 1.27 2007/01/25 10:28:30 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C * Copyright (C) 2003 Ferhat Ayaz @@ -43,8 +43,8 @@ * - attachments via MIME * - message based security (XML encryption/signation) * - automatic generation of a WS-Inspection document - * - Platform independent: Windows, Unix, Linux, MacOS, OpenVMS - * - Written in pure C. + * - Platform independent: Windows, Unix, Linux, MacOS, OpenVMS, AIX + * - Written in pure ANSI C (compiles with gcc -ansi). * * @section howto_sec HOWTOs and coding examples * @@ -54,6 +54,7 @@ * - @ref csoap_client_page * - @ref csoap_server_page * - @ref csoap_mime_page + * - @ref csoap_xmlsec_page * * @section help_sec How to help * @@ -92,8 +93,8 @@ * @subsection download_cvs_sec Checkout from CVS * * Do you want the latest source codes? You want to contribute a patch? Have you - * found a bug? Or whatever. You should check out csoap from CVS to play the game - * with us csoap developers. + * found a bug? Or whatever. You should check out cSOAP from CVS to play the game + * with us cSOAP developers. * * Web CVS access: http://csoap.cvs.sourceforge.net/csoap/libsoap/ * diff --git a/libcsoap/soap-xmlsec.h b/libcsoap/soap-xmlsec.h index f5ef77a..2952368 100644 --- a/libcsoap/soap-xmlsec.h +++ b/libcsoap/soap-xmlsec.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: soap-xmlsec.h,v 1.8 2007/01/05 09:03:34 m0gg Exp $ + * $Id: soap-xmlsec.h,v 1.9 2007/01/25 10:28:30 m0gg Exp $ * * CSOAP Project: A SOAP client/server library in C * Copyright (C) 2006 Heiko Ronsdorf @@ -24,7 +24,7 @@ #ifndef __csoap_xmlsec_h #define __csoap_xmlsec_h -/** @page csoap_xmlsec_page How to use xmlsec with csoap +/** @page csoap_xmlsec_page Howto use xmlsec with csoap * * @section csoap_xmlsec_toc Table of contents * @@ -59,7 +59,7 @@ * This module is implemented using the xmlsec1 library. * * @author H. Ronsdorf - * @version $Revision: 1.8 $ + * @version $Revision: 1.9 $ * * @see http://www.w3.org/TR/SOAP-dsig/ * @see http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss diff --git a/nanohttp/nanohttp-server.h b/nanohttp/nanohttp-server.h index 68d61c3..f9fed91 100644 --- a/nanohttp/nanohttp-server.h +++ b/nanohttp/nanohttp-server.h @@ -1,5 +1,5 @@ /****************************************************************** - * $Id: nanohttp-server.h,v 1.37 2007/01/03 13:41:52 m0gg Exp $ + * $Id: nanohttp-server.h,v 1.38 2007/01/25 10:24:10 m0gg Exp $ * * CSOAP Project: A http client/server library in C * Copyright (C) 2003 Ferhat Ayaz @@ -42,9 +42,11 @@ * * nanoHTTP is an embedded HTTP implementation. It comes with the following * features: + * - written in ANSI C (compiles with gcc -ansi) * - client/server HTTP engine - * - attachments via MIME - * - HTTPS support (SSL/TLS) using OpenSSL + * - attachments via MIME (http://www.ietf.org/rfc/rfc2045.txt) + * - HTTP Basic Authentication (http://www.ietf.org/rfc/rfc2617.txt) + * - optional HTTPS support (SSL/TLS) using OpenSSL (http://www.openssl.org) * * @section links_sec Howto to use the nanoHTTP library * @@ -60,9 +62,6 @@ * * @version 1.2 * - * @see http://www.ietf.org/rfc/rfc2616.txt - * @see http://www.openssl.org - * */ /** @page nanohttp_server_page Howto write an HTTP server diff --git a/nanohttp/nanohttp-ssl.h b/nanohttp/nanohttp-ssl.h index 894b3c2..e4b7058 100644 --- a/nanohttp/nanohttp-ssl.h +++ b/nanohttp/nanohttp-ssl.h @@ -1,5 +1,5 @@ /****************************************************************** -* $Id: nanohttp-ssl.h,v 1.29 2007/01/15 18:29:44 m0gg Exp $ +* $Id: nanohttp-ssl.h,v 1.30 2007/01/25 10:24:10 m0gg Exp $ * * CSOAP Project: A http client/server library in C * Copyright (C) 2001-2005 Rochester Institute of Technology @@ -24,34 +24,35 @@ #ifndef __nanohttp_ssl_h #define __nanohttp_ssl_h -/** @page nanohttp_ssl_page How to use SSL with nanoHTTP/cSOAP +/** @page nanohttp_ssl_page How to use SSL with nanoHTTP * * @section nanohttp_ssl_toc_sec Table of contents * * - @ref nanohttp_ssl_overview_sec * - @ref nanohttp_ssl_configuration_sec - * - @ref nanohttp_ssl_key_generation_sec - * - @ref nanohttp_ssl_cert_generation_sec - * - @ref nanohttp_ssl_ca_generation_sec - * - @ref nanohttp_ssl_ca_dir_sec - * - @ref nanohttp_ssl_ca_key_sec - * - @ref nanohttp_ssl_sign_sec + * - @ref nanohttp_ssl_key_management_sec + * - @ref nanohttp_ssl_key_generation_sec + * - @ref nanohttp_ssl_cert_generation_sec + * - @ref nanohttp_ssl_ca_generation_sec + * - @ref nanohttp_ssl_ca_dir_sec + * - @ref nanohttp_ssl_ca_key_sec + * - @ref nanohttp_ssl_sign_sec * - @ref nanohttp_ssl_cmdline_sec * - @ref nanohttp_ssl_verification_sec * - @ref nanohttp_ssl_faq_sec * * @section nanohttp_ssl_overview_sec How to create an SSL enabled HTTP service * - * There are tow basic steps involved in using nanoHTTP to create an SSL enabled - * HTTP service. + * There are two basic steps involved in using nanoHTTP to create a SSL enabled + * HTTP services: * * -# @ref nanohttp_ssl_configuration_sec - * -# @ref nanohttp_ssl_key_generation_sec + * -# @ref nanohttp_ssl_key_management_sec * * Additionally you may: * - * - Add the requisite command line arguments to your application - * - Write a certifcate verification routine + * -# @ref nanohttp_ssl_cmdline_sec + * -# @ref nanohttp_ssl_verification_sec * * @section nanohttp_ssl_configuration_sec Compilation with SSL support * @@ -63,13 +64,15 @@ * $ ./configure --with-ssl * @endcode * - * @section nanohttp_ssl_key_generation_sec Simple key generation + * @section nanohttp_ssl_key_management_sec Create an SSL key/certificate + * + * @subsection nanohttp_ssl_key_generation_sec Simple key generation * * @code * $ openssl req -nodes -days 1825 -subj "/CN=`hostname`" -newkey rsa:1024 -keyout sslkey.pem -out sslreq.pem * @endcode * - * @section nanohttp_ssl_cert_generation_sec Generate a key with a certificate + * @subsection nanohttp_ssl_cert_generation_sec Generate a key with a certificate * * @subsection nanohttp_ssl_a_sec Create a key and a certification request * @subsection nanohttp_ssl_b_sec Post the sslreq.pem to your favorite CA @@ -79,9 +82,9 @@ * $ cat ssl.cert >> sslkey.pem * @endcode * - * @section nanohttp_ssl_ca_generation_sec Generate a certification authority + * @subsection nanohttp_ssl_ca_generation_sec Generate a certification authority * - * @subsection nanohttp_ssl_ca_dir_sec Create the directory structure + * @subsubsection nanohttp_ssl_ca_dir_sec Create the directory structure * * @code * $ mkdir ca @@ -93,13 +96,13 @@ * $ chmod 700 ca/private * @endcode * - * @subsection nanohttp_ssl_ca_key_sec Generate the CA key + * @subsubsection nanohttp_ssl_ca_key_sec Generate the CA key * * @code * $ openssl req -x509 -nodes -days 1826 -subj "/CN=myCa" -newkey rsa:1024 -keyout ca/private/cakey.pem -out ca/cacert.pem * @endcode * - * @subsection nanohttp_ssl_sign_sec Sign a certification request + * @subsubsection nanohttp_ssl_sign_sec Sign a certification request * * @code * $ openssl ca -in sslreq.pem -out ssl.cert -- cgit v1.1-32-gdbae