Commit 5e2c4d82 authored by Pekka Pessi's avatar Pekka Pessi

http, ipt, nea, nta, nth, sip, soa, sres, stun: fixed references to headers

darcs-hash:20070627094532-65a35-3ca461181dbb71ae5e6a66a8cfa9de7f9e9394d5.gz
parent 1b1fb1ca
......@@ -20,7 +20,7 @@
* documented in a <a href="modules.html">submodule</a> for the header. In
* addition to the header structure, there is defined a @em header @em class
* structure and some standard functions for each header in the
* <http_header.h> include file. For header @c X, there are types,
* <sofia-sip/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,
......
......@@ -140,7 +140,7 @@ char *http_request_dup_one(http_header_t *dst, http_header_t const *src,
*
* Note that version string is not copied; it @b MUST remain constant during
* lifetime of the @c http_request_t object. You can use constants
* http_version_1_1 or http_version_1_0 declared in <http_header.h>.
* http_version_1_1 or http_version_1_0 declared in <sofia-sip/http_header.h>.
*/
http_request_t *http_request_create(su_home_t *home,
http_method_t method, char const *name,
......
......@@ -15,9 +15,6 @@
* @section ipt_overview Overview
*
* This module contain some routines useful for IPT applications, like
* - base64.h BASE64 encoding/decoding,
* - token64.h encoding/decoding binary as SIP/HTTP token,
* - utf8.h UTF8 encoding/decoding,
* - sha1.h SHA1 hash routines, and
* - rc4.h arcfour random number generator.
* - <sofia-sip/base64.h> BASE64 encoding/decoding,
* - <sofia-sip/token64.h> encoding/decoding binary as SIP/HTTP token,
*/
......@@ -64,7 +64,7 @@ tag_typedef_t authtag_module = PTRTAG_TYPEDEF(module);
* authentication module, like "Digest" or "Basic", or an plugin module,
* like "SGMF+Digest".
*
* @sa See <auth_plugin.h> for plugin interface.
* @sa See <sofia-sip/auth_plugin.h> for plugin interface.
*/
tag_typedef_t authtag_method = STRTAG_TYPEDEF(method);
......
......@@ -19,11 +19,10 @@
*
* @section auth_module Server Verifying Authentication
*
* The file <auth_module.h> defines the interface used by a server verifying
* the authentication from client. After the server has created an @ref
* auth_mod_t "authentication module", the usual authentication operation is
* simple enough:
* The file <sofia-sip/auth_module.h> defines the interface used by a server
* verifying the authentication from client. After the server has created an
* @ref auth_mod_t "authentication module", the usual authentication
* operation is simple enough:
* -# server initializes an #auth_status_t structure with information from
* the request
* -# server calls auth_mod_method()
......@@ -42,8 +41,8 @@
*
* When the server creates the authentication module with auth_mod_create(),
* it can specify numerous parameters affecting the authentication protocol
* and algorithms. The parameter tags are defined in <auth_module.h>. The
* most important parameters include:
* and algorithms. The parameter tags are defined in
* <sofia-sip/auth_module.h>. The most important parameters include:
*
* - AUTHTAG_METHOD(),
* - AUTHTAG_ALGORITHM(),
......@@ -52,7 +51,7 @@
*
* @section auth_client Client Authenticating User
*
* The file <auth_client.h> defines the interface used by a client
* The file <sofia-sip/auth_client.h> defines the interface used by a client
* authenticating a user with a server. Because there may be multiple
* servers or proxies requiring authentication, the client-side
* authentication information is represented using a list of #auth_client_t
......
......@@ -44,7 +44,7 @@
* The IPTSEC_DEBUG environment variable is used to determine the debug
* logging level for @b iptsec module. The default level is 3.
*
* @sa <su_debug.h>, iptsec_log, SOFIA_DEBUG
* @sa <sofia-sip/su_debug.h>, iptsec_log, SOFIA_DEBUG
*/
extern char const IPTSEC_DEBUG[];
......
......@@ -6,7 +6,7 @@
*
* Sofia Event API provides an interface to different events used in SIP
* presence and conferencing. Interface used both in client and server sides
* is presented in <nea.h>.
* is presented in <sofia-sip/nea.h>.
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
......
......@@ -67,7 +67,7 @@
* The NEA_DEBUG environment variable is used to determine the debug
* logging level for @b nea module. The default level is 3.
*
* @sa <su_debug.h>, nea_log, SOFIA_DEBUG
* @sa <sofia-sip/su_debug.h>, nea_log, SOFIA_DEBUG
*/
extern char const NEA_DEBUG[];
......
......@@ -282,7 +282,7 @@ union sm_arg_u {
* 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 <sofia-sip/su_debug.h>, #su_log_global, #SOFIA_DEBUG
*/
extern char const NTA_DEBUG[];
......@@ -6344,7 +6344,7 @@ nta_outgoing_t *nta_outgoing_default(nta_agent_t *agent,
* NTATAG_STATELESS(), NTATAG_DELAY_SENDING(), NTATAG_BRANCH_KEY(),
* NTATAG_ACK_BRANCH(), NTATAG_DEFAULT_PROXY(), NTATAG_PASS_100(),
* NTATAG_USE_TIMESTAMP(), NTATAG_USER_VIA(), TPTAG_IDENT(), NTATAG_TPORT(). All
* SIP tags from <sip_tag.h> can be used to manipulate the request message.
* SIP tags from <sofia-sip/sip_tag.h> can be used to manipulate the request message.
* SIP tags after SIPTAG_END() are ignored, however.
*/
nta_outgoing_t *nta_outgoing_tcreate(nta_leg_t *leg,
......@@ -6432,7 +6432,7 @@ nta_outgoing_t *nta_outgoing_tcreate(nta_leg_t *leg,
* NTATAG_STATELESS(), NTATAG_DELAY_SENDING(), NTATAG_BRANCH_KEY(),
* NTATAG_ACK_BRANCH(), NTATAG_DEFAULT_PROXY(), NTATAG_PASS_100(),
* NTATAG_USE_TIMESTAMP(), NTATAG_USER_VIA(), TPTAG_IDENT(), NTATAG_TPORT(). All
* SIP tags from <sip_tag.h> can be used to manipulate the request message.
* SIP tags from <sofia-sip/sip_tag.h> can be used to manipulate the request message.
* SIP tags after SIPTAG_END() are ignored, however.
*/
nta_outgoing_t *nta_outgoing_mcreate(nta_agent_t *agent,
......
......@@ -24,8 +24,9 @@
* (#nta_incoming_t).
*
* NTA also uses SIP message objects #msg_t and #sip_t for handling
* messages, as defined in <msg.h> and <sip.h>, respectively. The various
* SIP headers are also defined in <sip.h>.
* messages, as defined in <sofia-sip/msg.h> and <sofia-sip/sip.h>,
* respectively. The various SIP headers are also defined in
* <sofia-sip/sip.h>.
*
* @section nta_agent_t Creating an NTA Agent
*
......
......@@ -6,8 +6,8 @@
*
* NTH provides interface to simple HTTP transaction engines for both HTTP
* servers and clients. The transaction interface for both client and server
* is available through <nth.h>, tags controlling the options in
* <nth_tag.h>.
* is available through <sofia-sip/nth.h>, tags controlling the options in
* <sofia-sip/nth_tag.h>.
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
......
......@@ -174,7 +174,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 1.
*
* @sa <su_debug.h>, nth_client_log, #SOFIA_DEBUG
* @sa <sofia-sip/su_debug.h>, nth_client_log, #SOFIA_DEBUG
*/
extern char const NTH_DEBUG[];
......
......@@ -172,7 +172,7 @@ struct nth_request_s
* The NTH_DEBUG environment variable is used to determine the debug
* logging level for @b nth module. The default level is 1.
*
* @sa <su_debug.h>, nth_server_log, SOFIA_DEBUG
* @sa <sofia-sip/su_debug.h>, nth_server_log, SOFIA_DEBUG
*/
extern char const NTH_DEBUG[];
......
......@@ -15,7 +15,7 @@
*
* @section sip_overview Overview
*
* The structure of each header is defined in @b <sip.h>. In addition to the
* The structure of each header is defined in @b <sofia-sip/sip.h>. In addition to the
* header structure, there is defined a @em header @em class structure and
* some standard functions for each header in the include file @b
* <sofia-sip/sip_header.h>. For header @c X, there are types, functions,
......@@ -68,7 +68,7 @@
* structure. The fragments form a dual-linked list known as @e fragment @e
* chain as shown in the above figure. The buffers for the message, the
* fragment chain, and a whole other stuff is held by the generic message
* type, #msg_t, defined in <msg.h>. The internal structure of #msg_t is
* type, #msg_t, defined in <sofia-sip/msg.h>. The internal structure of #msg_t is
* known only within @b msg module and it is hidden from other modules.
*
* The abstract message module @b msg also drives the reverse process,
......@@ -168,7 +168,7 @@
* 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.
*
......@@ -572,14 +572,14 @@ 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
* phrases are defined in <sip_status.h>.
* phrases are defined in <sofia-sip/sip_status.h>.
*/
/**@defgroup sip_tag SIP Tags
*
* SIP headers in tag item lists and tagged argument lists.
*
* The include file <sip_tag.h> defines tags and tag items for including SIP
* The include file <sofia-sip/sip_tag.h> defines tags and tag items for including SIP
* headers in tag item lists or tagged argument lists. For each header,
* there is a tag for pointer to header object and an another tag for string
* containing header value. For example, @From header has tags
......
......@@ -122,7 +122,7 @@ static int soa_set_sdp(soa_session_t *ss,
* The SOA_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 <sofia-sip/su_debug.h>, su_log_global, SOFIA_DEBUG
*/
extern char const SOA_DEBUG[];
......
......@@ -558,7 +558,7 @@ static int m_get_domain(char *d, int n, sres_message_t *m, uint16_t offset);
* The SRESOLV_DEBUG environment variable is used to determine the debug
* logging level for @b sresolv module. The default level is 3.
*
* @sa <su_debug.h>, sresolv_log, SOFIA_DEBUG
* @sa <sofia-sip/su_debug.h>, sresolv_log, SOFIA_DEBUG
*/
extern SRESOLV_DEBUG;
#endif
......
......@@ -159,7 +159,7 @@ tag_typedef_t stuntag_register_events = BOOLTAG_TYPEDEF(register_events);
* int (stun_action_t)
*
* @par Values
* See types for stun_action_t in stun.h
* See types for stun_action_t in <sofia-sip/stun.h>
*
* Corresponding tag taking reference parameter is STUNTAG_ACTION_REF()
*/
......
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