Commit b78287fe authored by Pekka Pessi's avatar Pekka Pessi

Documentation fixes in msg module.

darcs-hash:20051027185106-65a35-3071ae5d78d640ac71d2decf3a0b3824b8cd34cc.gz
parent 0fdbdb88
...@@ -473,22 +473,21 @@ encountered. ...@@ -473,22 +473,21 @@ encountered.
* @defgroup msg_mime MIME Headers * @defgroup msg_mime MIME Headers
* *
* This submodule contains the header classes, functions and types for * This submodule contains the header classes, functions and types for
* handling MIME headers (RFC 2045) and MIME multipart (RFC 2046) processing. * handling MIME headers (@RFC2045) and MIME multipart (@RFC2046) processing.
* *
* The MIME headers implemented are as follows: * The MIME headers implemented are as follows:
* - #msg_accept_t - @b Accept header * - @ref msg_accept "@b Accept header"
* - #msg_accept_charset_t - @b Accept-Charser header * - @ref msg_accept_charset "@b Accept-Charser header"
* - #msg_accept_encoding_t - @b Accept-Encoding header * - @ref msg_accept_encoding "@b Accept-Encoding header"
* - #msg_accept_language_t - @b Accept-Language header * - @ref msg_accept_language "@b Accept-Language header"
* - #msg_content_disposition_t - @b Content-Disposition header * - @ref msg_content_disposition "@b Content-Disposition header"
* - #msg_content_encoding_t - @b Content-Encoding header * - @ref msg_content_encoding "@b Content-Encoding header"
* - #msg_content_base_t - @b Content-Base header * - @ref msg_content_id "@b Content-ID header"
* - #msg_content_id_t - @b Content-ID header * - @ref msg_content_location "@b Content-Location header"
* - #msg_content_location_t - @b Content-Location header * - @ref msg_content_language "@b Content-Language header"
* - #msg_content_language_t - @b Content-Language header * - @ref msg_content_md5 "@b Content-MD5 header"
* - #msg_content_md5_t - @b Content-MD5 header * - @ref msg_content_transfer_encoding "@b Content-Transfer-Encoding header"
* - #msg_content_transfer_encoding_t - @b Content-Transfer-Encoding header * - @ref msg_mime_version "@b MIME-Version header"
* - #msg_mime_version_t - @b MIME-Version header
*/ */
/** /**
......
...@@ -53,8 +53,11 @@ int msg_errno(msg_t const *msg); ...@@ -53,8 +53,11 @@ int msg_errno(msg_t const *msg);
void msg_set_errno(msg_t *msg, int err); void msg_set_errno(msg_t *msg, int err);
enum { enum {
/** Minimum size of a message buffer */
msg_min_size = 512, msg_min_size = 512,
/** Minimum size of external buffer */
msg_min_block = 8192, msg_min_block = 8192,
/** Number of external buffers */
msg_n_fragments = 8 msg_n_fragments = 8
}; };
......
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
* @CFILE msg_date.c * @CFILE msg_date.c
* @brief Parser for HTTP-Date and HTTP-Delta. * @brief Parser for HTTP-Date and HTTP-Delta.
* *
* Parsing functions for RFC 1123 (GMT) date. * Parsing functions for @RFC1123 (GMT) date.
* *
* @author Pekka Pessi <Pekka.Pessi@nokia.com> * @author Pekka Pessi <Pekka.Pessi@nokia.com>
* *
......
This diff is collapsed.
...@@ -34,7 +34,7 @@ ...@@ -34,7 +34,7 @@
/**@ingroup msg_mime /**@ingroup msg_mime
* @file msg_mime_protos.h * @file msg_mime_protos.h
* *
* Prototypes for MIME headers (RFC 2045). * Prototypes for MIME headers (@RFC2045).
* *
* #AUTO# * #AUTO#
* *
......
...@@ -1482,14 +1482,15 @@ static int msg_header_prepare(msg_mclass_t const *, int flags, ...@@ -1482,14 +1482,15 @@ static int msg_header_prepare(msg_mclass_t const *, int flags,
* @relates msg_s * @relates msg_s
* *
* The function msg_prepare() prepares a message for sending. It encodes all * The function msg_prepare() prepares a message for sending. It encodes all
* serialized fragments in the message. The #h_data field will point to the * serialized fragments in the message. In each fragment, the
* encoding result of size #h_len bytes. * msg_common_s::h_data field will point to the encoding result of size
* msg_common_s::h_len bytes.
* *
* When multiple header fields are represented as a comma-separated list * When multiple header fields are represented as a comma-separated list
* within a single header line, the first fragment in the header will * within a single header line, the first fragment in the header will
* contain all the text belonging to the header. The rest of the header * contain all the text belonging to the header. The rest of the header
* fields will have zero-length encoding with #h_data that points to the end * fields will have zero-length encoding with msg_common_s::h_data that
* of the line. * points to the end of the line.
* *
* @return Total size of the encoded message in bytes, or -1 upon an error. * @return Total size of the encoded message in bytes, or -1 upon an error.
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment