Moved project documentation from headers to doc/

4 files changed, 8 insertions, 137 deletions

diff --git a/libcsoap/soap-admin.h b/libcsoap/soap-admin.h
index 838a75b..d150a5c 100644
--- a/libcsoap/soap-admin.h
+++ b/libcsoap/soap-admin.h
@@ -1,5 +1,5 @@
 /******************************************************************
- *  $Id: soap-admin.h,v 1.6 2007/11/03 22:40:09 m0gg Exp $
+ *  $Id: soap-admin.h,v 1.7 2007/11/04 06:57:32 m0gg Exp $
  *
  * CSOAP Project:  A SOAP client/server library in C
  * Copyright (C) 2003-2006  Ferhat Ayaz
@@ -27,7 +27,7 @@
 
 /** @file soap-admin.h HTTP administrator interface
  *
- * @defgroup CSOAP_ADMIN
+ * @defgroup CSOAP_ADMIN HTTP administration interface
  * @ingroup CSOAP
  */
 /**@{*/
diff --git a/libcsoap/soap-logging.h b/libcsoap/soap-logging.h
index 68c9728..0493a16 100644
--- a/libcsoap/soap-logging.h
+++ b/libcsoap/soap-logging.h
@@ -1,5 +1,5 @@
 /******************************************************************
- *  $Id: soap-logging.h,v 1.1 2007/11/03 22:40:09 m0gg Exp $
+ *  $Id: soap-logging.h,v 1.2 2007/11/04 06:57:32 m0gg Exp $
  * 
  * CSOAP Project:  A http client/server library in C
  * Copyright (C) 2003-2006  Ferhat Ayaz
@@ -27,7 +27,7 @@
 
 /** @file soap-logging.h Logging definitions and prototypes
  *
- * @defgrpoup CSOAP_LOGGING Logging interface
+ * @defgroup CSOAP_LOGGING Logging interface
  * @ingroup CSOAP
  */
 /**@{*/
diff --git a/libcsoap/soap-server.h b/libcsoap/soap-server.h
index f2cebe5..938f49d 100644
--- a/libcsoap/soap-server.h
+++ b/libcsoap/soap-server.h
@@ -1,5 +1,5 @@
 /******************************************************************
- *  $Id: soap-server.h,v 1.28 2007/11/03 22:40:09 m0gg Exp $
+ *  $Id: soap-server.h,v 1.29 2007/11/04 06:57:32 m0gg Exp $
  *
  * CSOAP Project:  A SOAP client/server library in C
  * Copyright (C) 2003  Ferhat Ayaz
@@ -24,132 +24,6 @@
 #ifndef __csoap_server_h
 #define __csoap_server_h
 
-/**
- *
- * @mainpage Project overview
- *
- * @section project_intro_sec Introduction
- *
- * cSOAP is a client/server SOAP library implemented in pure C. It comes with
- * embedded transport servers for UDP and HTTP (nanoHTTP). The transferred XML
- * structures are handled by libxml2.
- *
- * @section project_features_sec Features
- *
- * - 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 a WS-Inspection document
- * - Platform independent: Windows, Unix, Linux, MacOS, OpenVMS, AIX
- * - Written in pure ANSI C (compiles with gcc -ansi).
- *
- * @section howto_sec HOWTOs and coding examples
- *
- * - @ref nanohttp_client_page
- * - @ref nanohttp_server_page
- * - @ref nanohttp_mime_page
- * - @ref csoap_client_page
- * - @ref csoap_server_page
- * - @ref csoap_mime_page
- * - @ref csoap_xmlsec_page
- *
- * @section help_sec How to help
- *
- * The development of cSOAP highly depends on your input! If you are trying
- * cSOAP let us know what you think of it (do you miss certain features?). Even
- * if you decide not to use it, please let us know why.
- *
- * @section projects_sec Projects that use cSOAP
- *
- * @subsection complearn_sec CompLearn
- *
- * 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
- *
- * @subsection download_stable_sec Download stable release
- *
- * A stable release is a tested version of cSOAP. Download this package if you
- * want to use it in your productive projects. 
- *
- * Download source code of libsoap-1.1.0.tar.gz:
- * http://prdownloads.sourceforge.net/csoap/libsoap-1.1.0.tar.gz?download
- *
- * @subsection download_snapshot_sec Download latest snapshot (nightly build)
- *
- * Latest snapshots are build nightly on a detected CVS commit. This is sometimes
- * not very stable but in some case are snapshots the better choice then the
- * stable version. This can happen if a very important bug was fixed or a new
- * feature was introduced. It is recommend to join the mailinglist.
- *
- * Download latest snapshot (nightly build):
- * http://csoap.sourceforge.net/downloads/libsoap-snapshot.tar.gz
- *
- * @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.
- *
- * Web CVS access: http://csoap.cvs.sourceforge.net/csoap/libsoap/
- *
- * @author	Ferhat Ayaz
- * @author	Michael Rans
- * @author	Matt Campbell
- * @author	Heiko Ronsdorf
- *
- * @version	1.2
- *
- * @see		http://csoap.sourceforge.net/
- * @see		http://www.libxml.org/
- * @see		http://www.openssl.org/
- * @see		http://www.aleksey.com/xmlsec/
- *
- */
-
-/** @page csoap_page cSOAP
- *
- * @section csoap_sec cSOAP
- *
- * cSOAP is a C-based implementation of the Simple Object Access Protocol (SOAP)
- * version 1.1.
- *
- * SOAP is a lightweight protocol for exchange of information in a decentralized,
- * distributed environment. It is an XML based protocol that consists of three
- * parts:
- * - an envelope that defines a framework for describing what is in a message and
- *   how to process it,
- * - a set of encoding rules for expressing instances of application-defined
- *   datatypes,
- * - and a convention for representing remote procedure calls and responses.
- * SOAP can potentially be used in combination with a variety of other protocols;
- * however, the only bindings defined in this document describe how to use SOAP
- * in combination with HTTP and HTTP Extension Framework.
- *
- * @section soap_howto_sec HOWTOs and coding examples
- *
- * - @subpage csoap_client_page
- * - @subpage csoap_server_page
- * - @subpage csoap_mime_page
- * - @subpage csoap_xmlsec_page
- *
- * @version	1.2
- *
- * @author	Ferhat Ayaz
- * @author	Michael Rans
- * @author	Matt Campbell
- * @author	Heiko Ronsdorf
- *
- * @see		http://www.w3.org/TR/soap/
- * @see		http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
- *
- */
-
 /** @page csoap_server_page Howto write a SOAP server
  *
  * @section soap_server_toc_sec Table of contents
diff --git a/libcsoap/soap-xmlsec.c b/libcsoap/soap-xmlsec.c
index df04e28..19b5ce7 100644
--- a/libcsoap/soap-xmlsec.c
+++ b/libcsoap/soap-xmlsec.c
@@ -1,5 +1,5 @@
 /******************************************************************
-*  $Id: soap-xmlsec.c,v 1.9 2007/11/03 22:40:10 m0gg Exp $
+*  $Id: soap-xmlsec.c,v 1.10 2007/11/04 06:57:32 m0gg Exp $
 *
 * CSOAP Project:  A SOAP client/server library in C
 * Copyright (C) 2003  Ferhat Ayaz
@@ -118,17 +118,14 @@ static void _soap_xmlsec_error_callback(const char *file, int line, const char *
   return;
 }
 
-/**
- *
- * Lookups key in the @store. The caller is responsible for destroying returned
- * key with #xmlSecKeyDestroy function.
+/** This function lookups key in the store. The caller is responsible
+ * for destroying returned key with #xmlSecKeyDestroy function.
  *
  * @param store the pointer to simple keys store.
  * @param name the desired key name.
  * @param keyInfoCtx the pointer to <dsig:KeyInfo/> node processing context.
  *
  * @return pointer to key or NULL if key not found or an error occurs.
- *
  */
 static xmlSecKeyPtr
 _soap_xmlsec_files_keys_store_find_key(xmlSecKeyStorePtr store, const xmlChar * name, xmlSecKeyInfoCtxPtr keyInfoCtx)