Commit 4c831fbb authored by Pekka Pessi's avatar Pekka Pessi

Fixed documentation.

darcs-hash:20051027190433-65a35-f29085d1578be76321217c6ea7ea95db6c435e47.gz
parent b78287fe
......@@ -23,7 +23,7 @@
* <http_header.h> include file. For header @c X, there are types,
* functions, macros and header class as follows:
*
* - @c #http_X_t is the structure used to store parsed header,
* - @c http_X_t is the structure used to store parsed header,
* - @c HTTP_X_INIT() initializes a static instance of http_X_t,
* - @c http_X_p() tests if header object is instance of header X,
* - @c http_X_make() is a macro that creates a header X object by
......
......@@ -22,7 +22,7 @@
*
*/
/**@cifle ucs4.c UCS-4 routines
/**@CFILE ucs4.c UCS-4 routines
*
* @author Pekka Pessi <pessi@research.nokia.com>
*
......
......@@ -28,7 +28,7 @@
/**@ingroup msg_mime
* @file msg_mime.h
*
* MIME headers and multipart messages (RFC 2045).
* MIME headers and multipart messages (@RFC2045).
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
*
......
......@@ -32,8 +32,7 @@
#include "config.h"
/**@APPS
* @page http_client Make HTTP request
/**@page http_client Make HTTP request
*
* @par Name
* http-client - HTTP request tool
......
......@@ -171,7 +171,7 @@ struct nth_client_s {
* The NTH_DEBUG environment variable is used to determine the debug
* logging level for @b nth module. The default level is 3.
*
* @sa <su_debug.h>, nth_client_log, SOFIA_DEBUG
* @sa <su_debug.h>, nth_client_log, #SOFIA_DEBUG
*/
extern char const NTH_DEBUG[];
......
......@@ -163,7 +163,6 @@ static tagi_t const nua_filter[] =
* @retval NULL upon an error
*
* @par Related tags:
* #NUTAG_MEDIA_DESCS \n
* #NUTAG_MEDIA_ENABLE \n
* #NUTAG_PROXY \n
* #NUTAG_SIP_PARSER \n
......@@ -171,8 +170,6 @@ static tagi_t const nua_filter[] =
* #NUTAG_UICC \n
* #NUTAG_CERTIFICATE_DIR \n
* #NUTAG_URL \n
* #NUTAG_MEDIA_ADDRESS \n
* #NUTAG_MEDIA_PARAMS \n
* all relevant NTATAG_* are passed to NTA
*
* @par Events:
......@@ -513,8 +510,8 @@ int nua_handle_has_active_call(nua_handle_t const *nh)
*
* Please note that this status is not affected by remote end putting
* this end on hold. Remote end can put each media separately on hold
* and status is reflected on #NUTAG_ACTIVE_AUDIO, #NUTAG_ACTIVE_VIDEO
* and #NUTAG_ACTIVE_CHAT tag values in nua_i_active event.
* and status is reflected on #SOATAG_ACTIVE_AUDIO, #SOATAG_ACTIVE_VIDEO
* and #SOATAG_ACTIVE_CHAT tag values in nua_i_active event.
*
* @param nh Pointer to operation handle
*
......@@ -832,10 +829,11 @@ void nua_unregister(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* Optionally
* - uses early media if #NUTAG_EARLY_MEDIA tag is used with non zero value
* - media parameters can be set by NUTAG_MEDIA_* tags
* - if #NUTAG_MEDIA_ENABLE tag is used with value zero then the MSS is
* - if #NUTAG_MEDIA_ENABLE tag is used with value zero then the soa is
* not used and application must create the SDP
* - nua_invite() can be used to change call status:
* - #NUTAG_HOLD tag with value 1 sets the call on hold
* - #SOATAG_HOLD tag listing the media put on hold or with value "*" sets
* the call on hold
* - if new media path is given either new media parameters are taken in
* use or new media is added to session.
*
......@@ -996,7 +994,7 @@ void nua_message(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
*
* A chat channel can be established during call setup using "message" media.
* An active chat channel is indicated using nua_i_active event containing
* #NUTAG_ACTIVE_CHAT tag. Chat messages can be sent using this channel with
* #SOATAG_ACTIVE_CHAT tag. Chat messages can be sent using this channel with
* nua_chat() function. Currently this is implemented using SIP MESSAGE
* requests but in future MSRP (message session protocol) will replace it.
*
......@@ -1296,8 +1294,7 @@ void nua_update(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
* #NUTAG_AUTH
*
* @par Events:
* #nua_r_authenticate \n
* #nua_r_* (operation events)
* (any operation events)
*/
void nua_authenticate(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...)
{
......
......@@ -147,7 +147,7 @@ extern tag_typedef_t nutag_max_subscriptions;
nutag_max_subscriptions_ref, tag_uint_vr(&(x))
extern tag_typedef_t nutag_max_subscriptions_ref;
/* Intentionally undocumented */
/** Intentionally undocumented. */
#define NUTAG_UICC(x) nutag_uicc, tag_str_v(x)
extern tag_typedef_t nutag_uicc;
......
PROJECT_NAME = "soa"
OUTPUT_DIRECTORY = ../docs/html/soa
INPUT = soa.docs soa.h soa.c
INPUT = soa.docs soa.h soa_add.h soa.c soa_tag.h soa_tag.c
@INCLUDE = ../docs/Doxyfile.conf
......
......@@ -239,15 +239,16 @@ tag_typedef_t soatag_address = STRTAG_TYPEDEF(address);
* @par Used with
*
* @par Parameter type
* enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED,
* SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY,
* SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
* enum { #SOA_ACTIVE_DISABLED, #SOA_ACTIVE_REJECTED,
* #SOA_ACTIVE_INACTIVE, #SOA_ACTIVE_SENDONLY,
* #SOA_ACTIVE_RECVONLY, #SOA_ACTIVE_SENDRECV }
*
* @par Values
* @c SOA_ACTIVE_INACTIVE (0) \n
* @c SOA_ACTIVE_SENDONLY (1) \n
* @c SOA_ACTIVE_RECVONLY (2) \n
* @c SOA_ACTIVE_SENDRECV (3) \n
* @c #SOA_ACTIVE_REJECTED (-8) \n
* @c #SOA_ACTIVE_INACTIVE (0) \n
* @c #SOA_ACTIVE_SENDONLY (1) \n
* @c #SOA_ACTIVE_RECVONLY (2) \n
* @c #SOA_ACTIVE_SENDRECV (3) \n
*
* Corresponding tag taking reference parameter is SOATAG_ACTIVE_AUDIO_REF()
*
......@@ -261,15 +262,16 @@ tag_typedef_t soatag_active_audio = INTTAG_TYPEDEF(active_audio);
* @par Used with
*
* @par Parameter type
* enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED,
* SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY,
* SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
* enum { #SOA_ACTIVE_DISABLED, #SOA_ACTIVE_REJECTED,
* #SOA_ACTIVE_INACTIVE, #SOA_ACTIVE_SENDONLY,
* #SOA_ACTIVE_RECVONLY, #SOA_ACTIVE_SENDRECV }
*
* @par Values
* @c SOA_ACTIVE_INACTIVE (0) \n
* @c SOA_ACTIVE_SENDONLY (1) \n
* @c SOA_ACTIVE_RECVONLY (2) \n
* @c SOA_ACTIVE_SENDRECV (3) \n
* @c #SOA_ACTIVE_REJECTED (-8) \n
* @c #SOA_ACTIVE_INACTIVE (0) \n
* @c #SOA_ACTIVE_SENDONLY (1) \n
* @c #SOA_ACTIVE_RECVONLY (2) \n
* @c #SOA_ACTIVE_SENDRECV (3) \n
*
* Corresponding tag taking reference parameter is SOATAG_ACTIVE_VIDEO_REF()
*/
......@@ -284,26 +286,28 @@ tag_typedef_t soatag_active_video = INTTAG_TYPEDEF(active_video);
* #nua_i_state \n
*
* @par Parameter type
* enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED,
* SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY,
* SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
* enum { #SOA_ACTIVE_DISABLED, #SOA_ACTIVE_REJECTED,
* #SOA_ACTIVE_INACTIVE, #SOA_ACTIVE_SENDONLY,
* #SOA_ACTIVE_RECVONLY, #SOA_ACTIVE_SENDRECV }
*
* @par Values
* @c SOA_ACTIVE_INACTIVE (0) \n
* @c SOA_ACTIVE_SENDONLY (1) \n
* @c SOA_ACTIVE_RECVONLY (2) \n
* @c SOA_ACTIVE_SENDRECV (3) \n
* @c #SOA_ACTIVE_REJECTED (-8) \n
* @c #SOA_ACTIVE_INACTIVE (0) \n
* @c #SOA_ACTIVE_SENDONLY (1) \n
* @c #SOA_ACTIVE_RECVONLY (2) \n
* @c #SOA_ACTIVE_SENDRECV (3) \n
*
* @par Parameter type
* enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED,
* SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY,
* SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
* enum { #SOA_ACTIVE_DISABLED, #SOA_ACTIVE_REJECTED,
* #SOA_ACTIVE_INACTIVE, #SOA_ACTIVE_SENDONLY,
* #SOA_ACTIVE_RECVONLY, #SOA_ACTIVE_SENDRECV }
*
* @par Values
* @c SOA_ACTIVE_INACTIVE (0) \n
* @c SOA_ACTIVE_SENDONLY (1) \n
* @c SOA_ACTIVE_RECVONLY (2) \n
* @c SOA_ACTIVE_SENDRECV (3) \n
* @c #SOA_ACTIVE_REJECTED (-8) \n
* @c #SOA_ACTIVE_INACTIVE (0) \n
* @c #SOA_ACTIVE_SENDONLY (1) \n
* @c #SOA_ACTIVE_RECVONLY (2) \n
* @c #SOA_ACTIVE_SENDRECV (3) \n
*
* Corresponding tag taking reference parameter is SOATAG_ACTIVE_IMAGE_REF()
*/
......@@ -316,15 +320,16 @@ tag_typedef_t soatag_active_image = INTTAG_TYPEDEF(active_image);
* @par Used with
*
* @par Parameter type
* enum { SOA_ACTIVE_DISABLED, SOA_ACTIVE_REJECTED,
* SOA_ACTIVE_INACTIVE, SOA_ACTIVE_SENDONLY,
* SOA_ACTIVE_RECVONLY, SOA_ACTIVE_SENDRECV }
* enum { #SOA_ACTIVE_DISABLED, #SOA_ACTIVE_REJECTED,
* #SOA_ACTIVE_INACTIVE, #SOA_ACTIVE_SENDONLY,
* #SOA_ACTIVE_RECVONLY, #SOA_ACTIVE_SENDRECV }
*
* @par Values
* @c SOA_ACTIVE_INACTIVE (0) \n
* @c SOA_ACTIVE_SENDONLY (1) \n
* @c SOA_ACTIVE_RECVONLY (2) \n
* @c SOA_ACTIVE_SENDRECV (3) \n
* @c #SOA_ACTIVE_REJECTED (-8) \n
* @c #SOA_ACTIVE_INACTIVE (0) \n
* @c #SOA_ACTIVE_SENDONLY (1) \n
* @c #SOA_ACTIVE_RECVONLY (2) \n
* @c #SOA_ACTIVE_SENDRECV (3) \n
*
* Corresponding tag taking reference parameter is SOATAG_ACTIVE_CHAT_REF()
*/
......@@ -413,4 +418,4 @@ tag_typedef_t soatag_srtp_integrity = BOOLTAG_TYPEDEF(srtp_integrity);
*
* Corresponding tag taking reference parameter is SOATAG_HOLD_REF()
*/
tag_typedef_t soatag_hold = INTTAG_TYPEDEF(hold);
tag_typedef_t soatag_hold = STRTAG_TYPEDEF(hold);
......@@ -123,10 +123,9 @@ int stun_is_requested(tag_type_t tag, tag_value_t value, ...)
/**
* Creates a STUN engine
*
* @param stun server hostname or IPv4 address
* @param server hostname or IPv4 address
* @param msg_integrity true if msg integr. should be used
*
*
*/
stun_engine_t *stun_engine_create(char const *server,
int msg_integrity)
......@@ -137,11 +136,11 @@ stun_engine_t *stun_engine_create(char const *server,
}
/**
* Creates a STUN engine
* Create a STUN engine
*
* @param tag,value,... tag-value list
*
* @TAGS
* @TAGS
* @TAG STUNTAG_SERVER() stun server hostname or dotted IPv4 address
* @TAG STUNTAG_INTEGRITY() true if msg integrity should be used
*
......
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