Commit dabd857a authored by Pekka Pessi's avatar Pekka Pessi
Browse files

msg: updated documentation

parent 3648671c
......@@ -7,6 +7,8 @@ INPUT = @srcdir@/ @srcdir@/sofia-sip sofia-sip @srcdir@ .
@INCLUDE = ../docs/Doxyfile.conf
@INCLUDE = ../sip/sip.doxyaliases
EXCLUDE_PATTERNS += msg_test*.h msg_test*.c
TAGFILES += ../docs/ipt.doxytags=../ipt \
../docs/su.doxytags=../su \
../docs/sip.doxytags=../sip \
......@@ -22,7 +22,7 @@
/**@file msg.c Message object implementation.
/**@internal @file msg.c Message object implementation.
* @author Pekka Pessi <>
......@@ -142,7 +142,7 @@ separator and the message body are all in their own fragment structure. The
fragments form a dual-linked list known as @e fragment @e chain as shown in
the above figure. The memory buffers for the message, the fragment chain,
and a whole lot of other stuff is held by the generic message type, #msg_t,
defined in <msg.h>. The internal structure of #msg_t is known only within @b
defined in <sofia-sip/msg.h>. The internal structure of #msg_t is known only within @b
msg module and it is opaque to other modules.
The @b msg parser engine also drives the reverse process, invoking the
......@@ -262,7 +262,7 @@ header members that are also found in the beginning of a header
structure. The @e sip_size indicates the size of the structure - the
application can extend the parser and #sip_t structure beyond the
original size. The @e sip_flags contains various flags used during the
parsing and printing process. They are documented in the <msg.h>. These
parsing and printing process. They are documented in the <sofia-sip/msg.h>. These
boilerplate members are followed by the pointers to various message
elements and headers.
......@@ -22,7 +22,8 @@
/**@ingroup msg_parser
* @ingroup msg_parser
* @file msg_generic.c
* @brief Functions for generic headers
......@@ -67,36 +67,6 @@ size_t memcspn(const void *mem, size_t memlen,
/** Protocol version of MIME */
char const msg_mime_version_1_0[] = "MIME/1.0";
/* Internally used version of msg_header_t */
union msg_mime_u
msg_common_t sh_common[1];
struct {
msg_common_t shn_common;
msg_header_t *shn_next;
} sh_header_next[1];
msg_multipart_t sh_multipart[1];
msg_accept_t sh_accept[1];
msg_accept_any_t sh_accept_any[1];
msg_accept_charset_t sh_accept_charset[1];
msg_accept_encoding_t sh_accept_encoding[1];
msg_accept_language_t sh_accept_language[1];
msg_content_disposition_t sh_content_disposition[1];
msg_content_encoding_t sh_content_encoding[1];
msg_content_id_t sh_content_id[1];
msg_content_language_t sh_content_language[1];
msg_content_length_t sh_content_length[1];
msg_content_location_t sh_content_location[1];
msg_content_type_t sh_content_type[1];
msg_mime_version_t sh_mime_version[1];
msg_warning_t sh_warning[1];
msg_unknown_t sh_unknown[1];
msg_separator_t sh_separator[1];
msg_payload_t sh_payload[1];
#include <sofia-sip/msg_parser.h>
#include <sofia-sip/msg_mime_protos.h>
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