summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar m0gg2006-12-09 09:27:11 +0000
committerGravatar m0gg2006-12-09 09:27:11 +0000
commitc6e5a6765f5377d22f87d224fc4cc957a20c2f6b (patch)
tree3af8e8cd63c68c5a13377a85a49140bdd666e704
parent4c24b62d85f7eeef94a7c854eabf11969de86ab7 (diff)
downloadcsoap-c6e5a6765f5377d22f87d224fc4cc957a20c2f6b.tar.gz
csoap-c6e5a6765f5377d22f87d224fc4cc957a20c2f6b.tar.bz2
Documentation enhancements
-rw-r--r--libcsoap/soap-env.h54
-rw-r--r--libcsoap/soap-nudp.h10
-rw-r--r--libcsoap/soap-server.h21
-rw-r--r--libcsoap/soap-wsil.h14
-rwxr-xr-xnanohttp/nanohttp-mime.h6
-rwxr-xr-xnanohttp/nanohttp-response.h4
6 files changed, 55 insertions, 54 deletions
diff --git a/libcsoap/soap-env.h b/libcsoap/soap-env.h
index 45f013a..fb046c6 100644
--- a/libcsoap/soap-env.h
+++ b/libcsoap/soap-env.h
@@ -1,5 +1,5 @@
/******************************************************************
- * $Id: soap-env.h,v 1.20 2006/11/28 23:45:57 m0gg Exp $
+ * $Id: soap-env.h,v 1.21 2006/12/09 09:27:11 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2003 Ferhat Ayaz
@@ -26,7 +26,7 @@
/** @file
*
- * SOAP Envelope
+ * \section soap_env SOAP Envelope
*
* A SOAP message is an XML document that consists of a mandatory SOAP envelope,
* an optional SOAP header, and a mandatory SOAP body. This XML document is
@@ -46,32 +46,32 @@
*
* The grammar rules are as follows:
* - Envelope
- * -# The element name is "Envelope".
- * -# The element MUST be present in a SOAP message
- * -# The element MAY contain namespace declarations as well as additional
- * attributes. If present, such additional attributes MUST be
- * namespace-qualified. Similarly, the element MAY contain additional sub
- * elements. If present these elements MUST be namespace-qualified and MUST
- * follow the SOAP Body element.
+ * -# The element name is "Envelope".
+ * -# The element MUST be present in a SOAP message
+ * -# The element MAY contain namespace declarations as well as additional
+ * attributes. If present, such additional attributes MUST be
+ * namespace-qualified. Similarly, the element MAY contain additional sub
+ * elements. If present these elements MUST be namespace-qualified and MUST
+ * follow the SOAP Body element.
* - Header
- * -# The element name is "Header".
- * -# The element MAY be present in a SOAP message. If present, the element MUST
- * be the first immediate child element of a SOAP Envelope element.
- * -# The element MAY contain a set of header entries each being an immediate
- * child element of the SOAP Header element. All immediate child elements of
- * the SOAP Header element MUST be namespace-qualified.
+ * -# The element name is "Header".
+ * -# The element MAY be present in a SOAP message. If present, the element MUST
+ * be the first immediate child element of a SOAP Envelope element.
+ * -# The element MAY contain a set of header entries each being an immediate
+ * child element of the SOAP Header element. All immediate child elements of
+ * the SOAP Header element MUST be namespace-qualified.
* - Body
- * -# The element name is "Body".
- * -# The element MUST be present in a SOAP message and MUST be an immediate
- * child element of a SOAP Envelope element. It MUST directly follow the SOAP
- * Header element if present. Otherwise it MUST be the first immediate child
- * element of the SOAP Envelope element.
- * -# The element MAY contain a set of body entries each being an immediate child
- * element of the SOAP Body element. Immediate child elements of the SOAP Body
- * element MAY be namespace-qualified. SOAP defines the SOAP Fault element,
- * which is used to indicate error messages (see section 4.4).
- *
- * SOAP encodingStyle Attribute
+ * -# The element name is "Body".
+ * -# The element MUST be present in a SOAP message and MUST be an immediate
+ * child element of a SOAP Envelope element. It MUST directly follow the SOAP
+ * Header element if present. Otherwise it MUST be the first immediate child
+ * element of the SOAP Envelope element.
+ * -# The element MAY contain a set of body entries each being an immediate
+ * child element of the SOAP Body element. Immediate child elements of the
+ * SOAP Body element MAY be namespace-qualified. SOAP defines the SOAP Fault
+ * element, which is used to indicate error messages.
+ *
+ * \subsection soap_env_enc SOAP encodingStyle Attribute
*
* The SOAP encodingStyle global attribute can be used to indicate the
* serialization rules used in a SOAP message. This attribute MAY appear on any
@@ -96,7 +96,7 @@
* encoding style of contained elements. This can be used to turn off any claims
* from containing elements.
*
- * Envelope Versioning Model
+ * \subsection soap_env_version Envelope Versioning Model
*
* SOAP does not define a traditional versioning model based on major and minor
* version numbers. A SOAP message MUST have an Envelope element associated with
diff --git a/libcsoap/soap-nudp.h b/libcsoap/soap-nudp.h
index fe76db7..2f56a7c 100644
--- a/libcsoap/soap-nudp.h
+++ b/libcsoap/soap-nudp.h
@@ -1,5 +1,5 @@
/******************************************************************
-* $Id: soap-nudp.h,v 1.4 2006/11/27 11:15:27 m0gg Exp $
+* $Id: soap-nudp.h,v 1.5 2006/12/09 09:27:11 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2006 Heiko Ronsdorf
@@ -26,7 +26,7 @@
/** @file
*
- * SOAP-over-UDP server/client module
+ * \section SOAP-over-UDP server/client module
*
* Many Application protocol patterns match the semantics of the User Datagram
* Protocol (UDP, RFC 768). Some do not require the delivery guarantees of TCP
@@ -37,10 +37,10 @@
* choice. It is anticipated that other protocols will have similar requirements.
*
* @author H. Ronsdorf
- * @version $Revision: 1.4 $
+ * @version $Revision: 1.5 $
*
- * @see http://specs.xmlsoap.org/ws/2004/09/soap-over-udp/soap-over-udp.pdf,
- * http://www.ietf.org/rfc/rfc768.txt
+ * @see http://specs.xmlsoap.org/ws/2004/09/soap-over-udp/soap-over-udp.pdf
+ * @see http://www.ietf.org/rfc/rfc768.txt
*
*/
diff --git a/libcsoap/soap-server.h b/libcsoap/soap-server.h
index e9ee9fa..2711aae 100644
--- a/libcsoap/soap-server.h
+++ b/libcsoap/soap-server.h
@@ -1,5 +1,5 @@
/******************************************************************
- * $Id: soap-server.h,v 1.16 2006/12/03 17:30:57 m0gg Exp $
+ * $Id: soap-server.h,v 1.17 2006/12/09 09:27:11 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2003 Ferhat Ayaz
@@ -37,19 +37,20 @@
* @section seq_features Features
*
* - different transport services
- * -# client/server HTTP transport service (including SSL)
- * -# client/server UDP transport service (multicast)
+ * - client/server HTTP transport service (including SSL)
+ * - client/server UDP transport service (multicast)
* - attachments via MIME
* - message based security (encryption/signation)
* - automatic generation of WS-Inspection
*
- * @author Ferhat Ayaz,
- * Michael Rans,
- * Matt Campbell,
- * Heiko Ronsdorf
+ * @author Ferhat Ayaz
+ * @author Michael Rans
+ * @author Matt Campbell
+ * @author Heiko Ronsdorf
*
- * @version $Revision: 1.16 $
+ * @version $Revision: 1.17 $
*
+ * @see http://csoap.sourceforge.net/
* @see http://www.libxml.org/
* @see http://www.openssl.org/
* @see http://www.aleksey.com/xmlsec/
@@ -76,7 +77,7 @@ herror_t soap_server_init_args(int argc, char **argv);
/**
*
- * Register a router to the soap server.
+ * Register a router to the SOAP server.
*
* <p><i>scheme</i>://<i>host</i>:<i>port</i>/<b>[context]</b>
*
@@ -111,7 +112,7 @@ extern herror_t soap_server_run(void);
/**
*
- * Frees the soap server.
+ * Frees the SOAP server.
*
* @see httpd_destroy
* @see udpd_destroy
diff --git a/libcsoap/soap-wsil.h b/libcsoap/soap-wsil.h
index faa739c..34f91f6 100644
--- a/libcsoap/soap-wsil.h
+++ b/libcsoap/soap-wsil.h
@@ -1,5 +1,5 @@
/******************************************************************
- * $Id: soap-wsil.h,v 1.3 2006/11/27 10:52:39 m0gg Exp $
+ * $Id: soap-wsil.h,v 1.4 2006/12/09 09:27:11 m0gg Exp $
*
* CSOAP Project: A SOAP client/server library in C
* Copyright (C) 2006 H. Ronsdorf
@@ -26,7 +26,7 @@
/** @file
*
- * WS-Inspection
+ * \section WS-Inspection
*
* The WS-Inspection specification provides an XML format for assisting in the
* inspection of a site for available services and a set of rules for how
@@ -58,11 +58,11 @@
* such a duplication is not desired.
*
* @author H. Ronsorf
- * @version $Revision: 1.3 $
+ * @version $Revision: 1.4 $
*
- * @see http://www-128.ibm.com/developerworks/library/specification/ws-wsilspec/,
- * http://www.w3.org/TR/wsdl,
- * http://www.uddi.org/
+ * @see http://www-128.ibm.com/developerworks/library/specification/ws-wsilspec/
+ * @see http://www.w3.org/TR/wsdl
+ * @see http://www.uddi.org/
*
*/
@@ -80,7 +80,7 @@ extern "C" {
/**
*
* Initializes the WSIL HTTP interface with commandline arguments. The generated
- * WSIL document can be seen at http://servername/inspection.wsil.
+ * WSIL document can be seen at http://localhost:10000/inspection.wsil .
*
* @param argc commandline arg count
* @param argv commandline arg vector
diff --git a/nanohttp/nanohttp-mime.h b/nanohttp/nanohttp-mime.h
index b20a59b..6ea0ef8 100755
--- a/nanohttp/nanohttp-mime.h
+++ b/nanohttp/nanohttp-mime.h
@@ -3,7 +3,7 @@
* | \/ | | | | \/ | | _/
* |_''_| |_| |_''_| |_'/ PARSER
*
-* $Id: nanohttp-mime.h,v 1.13 2006/12/03 17:30:57 m0gg Exp $
+* $Id: nanohttp-mime.h,v 1.14 2006/12/09 09:27:11 m0gg Exp $
*
* CSOAP Project: A http client/server library in C
* Copyright (C) 2003-2004 Ferhat Ayaz
@@ -31,12 +31,12 @@
/** @file
*
* @author Ferhat Ayaz
- * @version $Revision: 1.13 $
+ * @version $Revision: 1.14 $
*
* @see http://www.ietf.org/rfc/rfc2045.txt
* @see http://www.ietf.org/rfc/rfc2046.txt
* @see http://www.ietf.org/rfc/rfc4288.txt
- * @see http://www.ietf.org/rfc/rfc4289.txt,
+ * @see http://www.ietf.org/rfc/rfc4289.txt
*
*/
diff --git a/nanohttp/nanohttp-response.h b/nanohttp/nanohttp-response.h
index 88f9c4f..459a814 100755
--- a/nanohttp/nanohttp-response.h
+++ b/nanohttp/nanohttp-response.h
@@ -1,5 +1,5 @@
/******************************************************************
- * $Id: nanohttp-response.h,v 1.11 2006/11/26 20:13:06 m0gg Exp $
+ * $Id: nanohttp-response.h,v 1.12 2006/12/09 09:27:11 m0gg Exp $
*
* CSOAP Project: A http client/server library in C
* Copyright (C) 2003-2004 Ferhat Ayaz
@@ -26,7 +26,7 @@
/** @file
*
- * Response Header Fields
+ * \section Response Header Fields
*
* The response-header fields allow the server to pass additional information
* about the response which cannot be placed in the Status-Line. These header