summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar m0gg2007-01-05 09:03:34 +0000
committerGravatar m0gg2007-01-05 09:03:34 +0000
commit2cbfc2cfd30746c694b308e6067529c6b6971c83 (patch)
tree5c66346937c52114b8941bb1b89e377d3c7bac11
parent94144a21ff43ef12bc0132857ca1a712b560fdc3 (diff)
downloadcsoap-2cbfc2cfd30746c694b308e6067529c6b6971c83.tar.gz
csoap-2cbfc2cfd30746c694b308e6067529c6b6971c83.tar.bz2
Documentation enhancements
-rw-r--r--libcsoap/soap-xmlsec.h20
-rw-r--r--nanohttp/nanohttp-ssl.h37
2 files changed, 36 insertions, 21 deletions
diff --git a/libcsoap/soap-xmlsec.h b/libcsoap/soap-xmlsec.h
index 0a03164..f5ef77a 100644
--- a/libcsoap/soap-xmlsec.h
+++ b/libcsoap/soap-xmlsec.h
@@ -1,5 +1,5 @@
/******************************************************************
- * $Id: soap-xmlsec.h,v 1.7 2007/01/03 13:46:32 m0gg Exp $
+ * $Id: soap-xmlsec.h,v 1.8 2007/01/05 09:03:34 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2006 Heiko Ronsdorf
@@ -26,7 +26,7 @@
/** @page csoap_xmlsec_page How to use xmlsec with csoap
*
- * @section csoap_xmlsec_toc
+ * @section csoap_xmlsec_toc Table of contents
*
* - @ref csoap_xmlsec_key_sec
* - @ref csoap_xmlsec_cert_sec
@@ -36,6 +36,20 @@
* @section csoap_xmlsec_cert_sec Generate a key with a certificate
* @section csoap_xmlsec_cmdline_sec Commandline arguments for startup
*
+ * @code
+ * -CSOAPxmlsec Commandline argument to enable WS-Security.
+ *
+ * -CSOAPkeyfile Commandline argument to set the keyfile. If this argument is
+ * not specified, a random key will be generated.
+ *
+ * -CSOAPpassword Commandline argument to set the password of the key.
+ *
+ * -CSOAPcertfile Commandline argument to set a file of certificates.
+ * @endcode
+ *
+ * @see nanohttp_ssl_page
+ * @see http://www.aleksey.com/xmlsec/
+ *
*/
/** @file
@@ -45,7 +59,7 @@
* This module is implemented using the xmlsec1 library.
*
* @author H. Ronsdorf
- * @version $Revision: 1.7 $
+ * @version $Revision: 1.8 $
*
* @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-ssl.h b/nanohttp/nanohttp-ssl.h
index 5794c63..617d9f2 100644
--- a/nanohttp/nanohttp-ssl.h
+++ b/nanohttp/nanohttp-ssl.h
@@ -1,5 +1,5 @@
/******************************************************************
-* $Id: nanohttp-ssl.h,v 1.27 2007/01/03 13:41:52 m0gg Exp $
+* $Id: nanohttp-ssl.h,v 1.28 2007/01/05 09:03:34 m0gg Exp $
*
* CSOAP Project: A http client/server library in C
* Copyright (C) 2001-2005 Rochester Institute of Technology
@@ -34,8 +34,8 @@
* - @ref nanohttp_ssl_ca_dir_sec
* - @ref nanohttp_ssl_ca_key_sec
* - @ref nanohttp_ssl_sign_sec
- * - @ref nanohttp_cmdline_sec
- * - @ref nanohttp_faq_sec
+ * - @ref nanohttp_ssl_cmdline_sec
+ * - @ref nanohttp_ssl_faq_sec
*
* @section nanohttp_ssl_key_generation_sec Simple key generation
*
@@ -79,7 +79,7 @@
* $ openssl ca -in sslreq.pem -out ssl.cert
* @endcode
*
- * @section nanohttp_cmdline_sec Commandline arguments at startup
+ * @section nanohttp_ssl_cmdline_sec Commandline arguments at startup
*
* @code
* -NHTTPS Enable https protocol in the nanoHTTP server
@@ -110,25 +110,26 @@
* @section nanohttp_ssl_faq_sec Frequently asked questions
*
* - Howto hide the password
- * You can use the following functions before calling httpd_init, httpc_init
- * and accordingly soap_server_init, soap_client_init. The are roughly the same
- * then the commandline versions.
*
- * @code
- * hssl_enable(void)
- * hssl_set_certificate(const char *CERTfile)
- * hssl_set_certpass(const char *pass)
- * hssl_set_ca(const char *CAfile)
- * @endcode
+ * You can use the following functions before calling httpd_init, httpc_init
+ * and accordingly soap_server_init, soap_client_init. The are roughly the same
+ * then the commandline versions.
+ *
+ * @code
+ * hssl_enable(void)
+ * hssl_set_certificate(const char *CERTfile)
+ * hssl_set_certpass(const char *pass)
+ * hssl_set_ca_list(const char *CAfile)
+ * @endcode
*
- * NOTE: If you use this functions an specify the commandline arguments, then
- * the commandline arguments take precedence.
+ * NOTE: If you use this functions an specify the commandline arguments, then
+ * the commandline arguments take precedence.
*
* - What else?
*
- * @code
- * int hssl_enabled(void)
- * @endcode
+ * @code
+ * hssl_enabled(void)
+ * @endcode
*
*/