Commit 0e1c5dd5 authored by Pekka Pessi's avatar Pekka Pessi

msg, nua, sip, su: fixed doxygen errors.

darcs-hash:20060926193222-65a35-17d2ab87b775f2729860ab9699752ed23ad27d23.gz
parent 4b9981ca
......@@ -74,9 +74,9 @@ typedef unsigned long msg_time_t;
/**Public protocol-specific message structure for accessing the message.
*
* This type can be either #sip_t, #rtsp_t or #http_t, depending on the
* message. The base structure used by msg module is defined in struct
* #msg_pub_s.
* This type can be either #sip_t, #http_t, or #msg_multipart_t, depending
* on the message. The base structure used by msg module is defined in
* struct #msg_pub_s.
*/
typedef MSG_PUB_T msg_pub_t;
......@@ -105,7 +105,7 @@ typedef struct msg_auth_s msg_auth_t;
/** Common part of the header objects (or message fragments).
*
* This structure is also known as #sip_common_t or #rtsp_common_t.
* This structure is also known as #msg_common_t or #sip_common_t.
*/
struct msg_common_s {
msg_header_t *h_succ; /**< Pointer to succeeding fragment. */
......
......@@ -1610,12 +1610,15 @@ SOFIAPUBVAR tag_typedef_t nutag_substate;
#define NUTAG_SUBSTATE_REF(x) nutag_substate_ref, tag_int_vr(&(x))
SOFIAPUBVAR tag_typedef_t nutag_substate_ref;
/** Parameter type of NUTAG_SUBSTATE() */
enum nua_substate {
/** Extended state, considered as active. */
nua_substate_extended = nea_extended,
/** Embryonic subscription: SUBSCRIBE sent */
nua_substate_embryonic = nea_embryonic,
nua_substate_pending = nea_pending,
nua_substate_active = nea_active,
nua_substate_terminated = nea_terminated
nua_substate_pending = nea_pending, /**< Pending subscription */
nua_substate_active = nea_active, /**< Active subscription */
nua_substate_terminated = nea_terminated /**< Terminated subscription */
};
/**Default lifetime for implicit subscriptions created by REFER.
......
......@@ -234,13 +234,12 @@
* instance, the contents of header "MIME-Version" is stored in a structure
* called sip_mime_version_t.
*
* @{
*/
/**
* @page sip_header_x SIP Header X - Conventions
/**@ingroup sip_headers
* @defgroup sip_header_x SIP Header X - Conventions
*
* For a SIP header X, there types, functions, macros and global data
* For a SIP header X, there are types, functions, macros and global data
* declared in <sofia-sip/sip_protos.h> and <sofia-sip/sip_hclass.h> as
* follows:
* - #sip_X_t is the structure used to store parsed header,
......@@ -298,11 +297,11 @@
* array of string pointers. Pointer to the array is stored to @a X_params.
*
* For more complex header structures, see #sip_contact_t or #sip_rack_t.
*
* @{
*/
/**@ingroup sip_X
*
* The structure #sip_X_t contains representation of a SIP
/**The structure #sip_X_t contains representation of a SIP
* @ref sip_header_x "X" header.
*
* The #sip_X_t is defined as follows:
......@@ -317,8 +316,7 @@
*/
typedef struct sip_X_s sip_X_t;
/**@ingroup sip_X
* @var msg_hclass_t sip_X_class[];
/**@var msg_hclass_t sip_X_class[];
* @brief Header class for SIP X.
*
* The header class sip_X_class defines how a SIP
......@@ -326,7 +324,6 @@ typedef struct sip_X_s sip_X_t;
* contains methods used by SIP parser and other functions
* to manipulate the sip_X_t header structure.
*
* @{
*/
SIP_DLL extern msg_hclass_t sip_X_class[];
......@@ -458,8 +455,7 @@ sip_X_t *sip_X_dup(su_home_t *home, sip_X_t const *hdr);
* The function sip_X_copy() returns a pointer to
* newly copied header structure, or NULL upon an error.
*/
sip_X_t *sip_X_copy(su_home_t *home,
sip_X_t const *hdr);
sip_X_t *sip_X_copy(su_home_t *home, sip_X_t const *hdr);
/**Make a header structure sip_X_t.
*
......@@ -568,10 +564,11 @@ int sip_X_d(su_home_t *home, sip_header_t *h, char *s, int bsiz);
* The function sip_X_e() returns the number of characters required for the
* encoding.
*
* @}
*/
int sip_X_e(char buf[], int bsiz, sip_header_t const *h, int flags);
/** @} */
/**@defgroup sip_status_codes SIP Status Codes and Reason Phrases
*
* The macros and variables for the standard SIP status codes and reason
......
......@@ -41,6 +41,7 @@
SOFIA_BEGIN_DECLS
/** Local address info structure. */
typedef struct su_localinfo_s su_localinfo_t;
/** Local address info structure. */
......
......@@ -1138,7 +1138,8 @@ tagi_t *t_ns_filter(tagi_t *dst,
return dst;
}
}
/** Namespace filtering class */
tag_class_t ns_tag_class[1] =
{{
sizeof(ns_tag_class),
......
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