Commit 93b14c22 authored by Pekka Pessi's avatar Pekka Pessi

Updated top-level documentation. Added links from submodules to toplevel.

For module-specific mainpage, added @MODULEPAGE alias.
For links, added @SofiaSIP alias.

darcs-hash:20060914133229-65a35-c44ee76d46181248ed8d6c10b35f911d9ee31dde.gz
parent 051018fb
......@@ -26,3 +26,5 @@ TAGFILES += soa.doxytags=soa
TAGFILES += nea.doxytags=nea
TAGFILES += nua.doxytags=nua
TAGFILES += features.doxytags=features
EXAMPLE_PATH = ../sip
......@@ -5,14 +5,18 @@ PREDEFINED = DOX \
DOXYGEN_ONLY=1 \
DOCUMENTATION_ONLY=1 \
SU_HAVE_INLINE=1 su_inline=inline \
SOFIA_BEGIN_DECLS SOFIA_END_DECLS SOFIAPUBFUN SOFIACALL \
SOFIAPUBVAR=extern \
SU_DLL SIP_DLL RTSP_DLL SU_DLL NTA_DLL NUA_DLL MSG_DLL AUTH_DLL \
NTH_DLL HTTP_DLL \
__attribute__()=
ALIASES = \
"MODULEPAGE=\mainpage Sofia SIP User Agent Library - " \
"CONTACT=\par Contact:\n" \
"STATUS=\par Status:\n" \
"LICENSE=\par License:\n" \
"SofiaSIP=<a href=\"../index.html\">Sofia SIP</a>" \
"DEF=\def" \
"TAGS=\par Related Tags:" \
"TAG=\par \n" \
......
......@@ -15,11 +15,14 @@ WARNINGS = YES
DISABLE_INDEX = NO
HAVE_DOT = YES
CLASS_GRAPH = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = NO
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = NO
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
HIDE_UNDOC_RELATIONS = YES
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_SCOPE_NAMES = YES
......
......@@ -91,7 +91,7 @@ contents of file @e ipt.docs:
@verbatim
/**
@mainpage IPT Library
@MODULEPAGE "ipt" - Utility Module
@section ipt_meta Module Meta Information
......@@ -99,7 +99,7 @@ Utility library for IP Telephony applications.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
This diff is collapsed.
/* -*- text -*- */
/**@mainpage Sofia User Agent Library Features
/**@MODULEPAGE "features" Module
@section features_meta Module Meta Information
......@@ -9,7 +9,7 @@ features possibly available through the @ref subdirs "sofia-sip-ua" binary API.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/* -*- c -*- */
/**@mainpage HTTP Parser - "http"
/**@MODULEPAGE "http" - HTTP Parser Module
*
* @section http_meta Module Meta Information
*
......@@ -9,7 +9,7 @@
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @STATUS Core library
* @STATUS @SofiaSIP Core library
*
* @LICENSE LGPL
*
......
/* -*- c -*- */
/**@mainpage IPT Library
/**@MODULEPAGE "ipt" - Utility Module
*
* @section ipt_meta Module Meta Information
*
......@@ -8,7 +8,7 @@
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @STATUS Core library
* @STATUS @SofiaSIP Core library
*
* @LICENSE LGPL
*
......
/* -*- C -*- */
/**@mainpage IP Telephony Security Library
/**@MODULEPAGE "iptsec" - Authentication Module
*
* @section iptsec_meta Module Meta Information
*
* The IP Telephony Security module currently provides interfaces to HTTP
* The iptsec module currently provides interfaces to HTTP
* Basic and Digest authentication, used by HTTP and SIP protocol elements.
* There are both
* @ref auth_client "client-side" and
......@@ -13,7 +13,7 @@
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @STATUS Core library
* @STATUS @SofiaSIP Core library
*
* @LICENSE LGPL
*
......
/* -*- text -*- */
/**@mainpage Sofia SIP Stack: Message Parser, Message and Header Objects
/**@MODULEPAGE "msg" - Message Parser Module
@section msg_meta Module Meta Information
This module contains parser and functions for manipulating messages and
headers for text-based protocols like SIP, RTSP and HTTP. It also
headers for text-based protocols like SIP, HTTP and RTSP. It also
provides parsing of MIME headers and MIME multipart messages common to
these protocols.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/* -*- c -*- */
/**@mainpage Sofia Event API - "nea"
/**@MODULEPAGE "nea" - SIP Events Module
*
* @section nea_meta Module Meta Information
*
......@@ -10,7 +10,7 @@
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @STATUS Core library
* @STATUS @SofiaSIP Core library
*
* @LICENSE LGPL
*
......
/* -*- c -*- */
/**@mainpage Sofia HTTP Transaction Engine - "nth"
/**@MODULEPAGE "nth" - HTTP Transactions Module
*
* @section nth_meta Module Meta Information
*
......@@ -11,7 +11,7 @@
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @STATUS Core library
* @STATUS @SofiaSIP Core library
*
* @LICENSE LGPL
*
......
/* -*- text -*- */
/**@mainpage Sofia User Agent Library - nua
/**@MODULEPAGE "nua" - High-Level User Agent Module
@section nua_meta Module Meta Information
......@@ -10,7 +10,7 @@ messaging and event retrieval.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/* -*- c -*- */
/**@mainpage SDP Module
/**@MODULEPAGE "sdp" - SDP Module
@section sdp_meta Module Meta Information
The @b sdp module provides a simple "C" parser interface for SDP
[<a href="ftp://ftp.funet.fi/rfc/rfc2327.txt">RFC2327</a>], <em>Session
Description Protocol</em>.
The @b sdp module provides a simple "C" parser interface for SDP [@RFC2327],
<em>Session Description Protocol</em>. The parser also implements support
for IPv6 addresses as per @RFC3266. The @RFC4566 should be supported, but we
have not checked since draft-eitf-mmusic-sdp-new-17 or so.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/**@mainpage Sofia SDP Offer/Answer Engine
/**@MODULEPAGE "soa" - SDP Offer/Answer Engine Module
@section soa_meta Module Information
The Sofia @b soa module consists of an asynchronous SDP Offer/Answer engine
The Sofia SIP @b soa module consists of an asynchronous SDP Offer/Answer engine
library. The interface to library is defined in <soa.h>.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/**@mainpage Sofia Asynchronous DNS Resolver
/**@MODULEPAGE "sresolv" - Asynchronous DNS Resolver
@section sresolv_meta Module Information
......@@ -11,7 +11,7 @@ An alternative interface is defined by <sofia-resolv/sres.h>,
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/**@mainpage Sofia STUN Module
/**@MODULEPAGE "stun" - STUN Client and Server Module
@section stun_meta Module Meta Information
......@@ -7,7 +7,7 @@ client library.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
......
/* -*- C -*- */
/**@mainpage Sofia OS Services and Utility Library
/**@MODULEPAGE "su" - OS Services and Utilities
*
* @section su_meta Module Information
*
......@@ -9,7 +9,7 @@
*
* @CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @STATUS Core library
* @STATUS @SofiaSIP Core library
*
* @LICENSE LGPL
*
......
/**@mainpage Transport Module
/**@MODULEPAGE "tport" - Transport Module
@section tport_meta Module Information
......
/**@mainpage Sofia URL Module
/**@MODULEPAGE "url" - URL Module
@section url_meta Module Meta Information
The Sofia @b url module contains macros and functions for using URL
datatype, parsing and printing URLs.
datatype #url_t, parsing and printing URLs.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
@STATUS Core library
@STATUS @SofiaSIP Core library
@LICENSE LGPL
@section url_syntax Using URL Library
The URL library provides URL datatype and helper functions related to it.
There is URL parser, which separates the URL components to the url_t
There is URL parser, which separates the URL components to the #url_t
structure.
@note
......@@ -61,10 +61,10 @@ sip:user:pass\@example.com;user=ip
tel:+358718008000
@endcode
@subsection url_parsing Converting a String to url_t
@subsection url_parsing Converting a String to #url_t
The decoding function url_d() takes a string and splits it into parts as
shown above. The substrings are stored into the #url_t structure. When
shown above. The substrings are stored into the ##url_t structure. When
decoding, the hex encoding using \% is removed if the encoded character can
syntactically be part of the field. For instance, "%41" is decoded as
"A" in the user part, but "%40" (@) is left as is. (This is called
......@@ -93,7 +93,7 @@ as follows:
Other functions parsing URLs are as follows:
- url_hdup() (it takes a string as @a url parameter)
@subsection url_parsing Converting a url_t structure to string
@subsection url_parsing Converting a #url_t structure to string
The url_e() encodes the url, in other words, it joins the substrings in
#url_t to the provided buffer.
......@@ -124,7 +124,7 @@ the url.h include file:
- url_update()
- url_digest()
In addition to the basic URL structure, url_t, the library interface
In addition to the basic URL structure, #url_t, the library interface
provides an union type #url_string_t for passing unparsed strings instead
of parsed URLs as function arguments:
- url_string_p()
......
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