Commit f1602091 authored by Pekka Pessi's avatar Pekka Pessi

soa.c, nta.c, msg.h, msg_generic.c: updated documentation.

darcs-hash:20061207085643-65a35-666d5b0320a7bc4196fa8677bbdba9e85cac96e1.gz
parent 70e51d02
......@@ -136,6 +136,12 @@ issize_t msg_numeric_e(char b[], isize_t bsiz, msg_header_t const *h, int flags)
/* ====================================================================== */
/* Comma-separated list */
/** @typedef struct msg_list_s msg_list_t;
*
* Type for token list headers.
*
*/
issize_t msg_list_d(su_home_t *home, msg_header_t *h, char *s, isize_t slen)
{
return msg_commalist_d(home, &s, &h->sh_list->k_items, NULL);
......
......@@ -74,8 +74,10 @@ SOFIAPUBFUN int msg_is_prepared(msg_t const *msg);
SOFIAPUBFUN usize_t msg_size(msg_t const *msg);
SOFIAPUBFUN usize_t msg_maxsize(msg_t *msg, usize_t maxsize);
/** Cast a #msg_t pointer to a #su_home_t pointer. */
#define msg_home(h) ((su_home_t*)(h))
/** Streaming state of a #msg_t object. */
enum msg_streaming_status {
/** Disable streaming */
msg_stop_streaming = 0,
......
......@@ -283,14 +283,14 @@ union sm_arg_u {
/* Global module data */
/**@var NTA_DEBUG
/**@var char const NTA_DEBUG[];
*
* Environment variable determining the default debug log level.
*
* The NTA_DEBUG environment variable is used to determine the default
* debug logging level. The normal level is 3.
*
* @sa <su_debug.h>, su_log_global, SOFIA_DEBUG
* @sa <su_debug.h>, #su_log_global, #SOFIA_DEBUG
*/
extern char const NTA_DEBUG[];
......
......@@ -821,7 +821,7 @@ int soa_get_warning(soa_session_t *ss, char const **return_text)
*
* @sa @RFC3261 section 11, soa_set_capability_sdp(),
* SOATAG_CAPS_SDP(), SOATAG_CAPS_SDP_STR(),
* nua_options(), #nua_i_options()
* nua_options(), #nua_i_options
*/
int soa_get_capability_sdp(soa_session_t const *ss,
sdp_session_t const **return_sdp,
......@@ -871,7 +871,7 @@ int soa_get_capability_sdp(soa_session_t const *ss,
*
* @sa @RFC3261 section 11, soa_get_capability_sdp(),
* SOATAG_CAPS_SDP(), SOATAG_CAPS_SDP_STR(),
* nua_options(), #nua_i_options()
* nua_options(), #nua_i_options
*/
int soa_set_capability_sdp(soa_session_t *ss,
sdp_session_t const *sdp,
......
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