Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Open sidebar
BC
public
external
sofia-sip
Commits
503410fc
Commit
503410fc
authored
Feb 15, 2006
by
Pekka Pessi
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fixed problems in doxygen documentation and dist.
darcs-hash:20060215202133-65a35-cc1226bf839ec0d8dd39187d99e4829226c38e95.gz
parent
ec341de4
Changes
34
Hide whitespace changes
Inline
Side-by-side
Showing
34 changed files
with
160 additions
and
108 deletions
+160
-108
libsofia-sip-ua/Makefile.am
libsofia-sip-ua/Makefile.am
+10
-9
libsofia-sip-ua/bnf/Doxyfile
libsofia-sip-ua/bnf/Doxyfile
+1
-1
libsofia-sip-ua/docs/Doxyfile
libsofia-sip-ua/docs/Doxyfile
+18
-18
libsofia-sip-ua/docs/Doxyfile.conf
libsofia-sip-ua/docs/Doxyfile.conf
+1
-0
libsofia-sip-ua/docs/Makefile.am
libsofia-sip-ua/docs/Makefile.am
+1
-0
libsofia-sip-ua/docs/mainpage.docs
libsofia-sip-ua/docs/mainpage.docs
+33
-7
libsofia-sip-ua/features/Doxyfile
libsofia-sip-ua/features/Doxyfile
+12
-12
libsofia-sip-ua/features/features.c
libsofia-sip-ua/features/features.c
+22
-11
libsofia-sip-ua/features/features.docs
libsofia-sip-ua/features/features.docs
+1
-1
libsofia-sip-ua/features/sofia-sip/features.h.in
libsofia-sip-ua/features/sofia-sip/features.h.in
+2
-2
libsofia-sip-ua/http/Doxyfile
libsofia-sip-ua/http/Doxyfile
+1
-1
libsofia-sip-ua/ipt/Doxyfile
libsofia-sip-ua/ipt/Doxyfile
+1
-1
libsofia-sip-ua/iptsec/Doxyfile
libsofia-sip-ua/iptsec/Doxyfile
+1
-1
libsofia-sip-ua/msg/Doxyfile
libsofia-sip-ua/msg/Doxyfile
+1
-1
libsofia-sip-ua/msg/msg_parser_util.c
libsofia-sip-ua/msg/msg_parser_util.c
+2
-2
libsofia-sip-ua/nea/Doxyfile
libsofia-sip-ua/nea/Doxyfile
+1
-1
libsofia-sip-ua/nta/Doxyfile
libsofia-sip-ua/nta/Doxyfile
+1
-1
libsofia-sip-ua/nth/Doxyfile
libsofia-sip-ua/nth/Doxyfile
+1
-1
libsofia-sip-ua/nua/Doxyfile
libsofia-sip-ua/nua/Doxyfile
+1
-1
libsofia-sip-ua/nua/sofia-sip/nua.h
libsofia-sip-ua/nua/sofia-sip/nua.h
+2
-2
libsofia-sip-ua/sdp/Doxyfile
libsofia-sip-ua/sdp/Doxyfile
+1
-1
libsofia-sip-ua/sip/Doxyfile
libsofia-sip-ua/sip/Doxyfile
+3
-2
libsofia-sip-ua/sip/sip_parser.docs
libsofia-sip-ua/sip/sip_parser.docs
+3
-3
libsofia-sip-ua/soa/Doxyfile
libsofia-sip-ua/soa/Doxyfile
+2
-1
libsofia-sip-ua/sresolv/Doxyfile
libsofia-sip-ua/sresolv/Doxyfile
+1
-1
libsofia-sip-ua/stun/Doxyfile
libsofia-sip-ua/stun/Doxyfile
+1
-1
libsofia-sip-ua/stun/Makefile.am
libsofia-sip-ua/stun/Makefile.am
+2
-0
libsofia-sip-ua/su/Doxyfile
libsofia-sip-ua/su/Doxyfile
+1
-1
libsofia-sip-ua/su/su_bm.c
libsofia-sip-ua/su/su_bm.c
+1
-1
libsofia-sip-ua/tport/Doxyfile
libsofia-sip-ua/tport/Doxyfile
+1
-1
libsofia-sip-ua/tport/Makefile.am
libsofia-sip-ua/tport/Makefile.am
+2
-2
libsofia-sip-ua/url/Doxyfile
libsofia-sip-ua/url/Doxyfile
+1
-1
libsofia-sip-ua/url/sofia-sip/url.h
libsofia-sip-ua/url/sofia-sip/url.h
+2
-2
libsofia-sip-ua/url/url.docs
libsofia-sip-ua/url/url.docs
+26
-18
No files found.
libsofia-sip-ua/Makefile.am
View file @
503410fc
...
...
@@ -5,7 +5,7 @@ AUTOMAKE_OPTIONS = foreign
# note: order does matter in the subdir list
SUBDIRS
=
su features bnf sresolv sdp url msg sip stun ipt soa
\
tport http nta nea iptsec nth nua
DIST_SUBDIRS
=
docs
$(SUBDIRS)
DIST_SUBDIRS
=
$(SUBDIRS)
docs
EXTRA_DIST
=
sofia.am
DOXYGEN
=
doxygen
...
...
@@ -50,25 +50,26 @@ built-sources-recursive clean-built-sources-recursive $(COVERAGE_RECURSIVE):
done
;
empty-doxytags
:
@
echo
Generating empty doxytags
;
\
@
echo
Generating empty doxytags
cd
${srcdir}
;
\
mkdir
-p
docs/html
;
\
for
d
in
$(DIST_SUBDIRS)
;
do
\
test
-r
$$
d/Doxyfile
||
continue
;
\
test
-
d
docs/
$$
d
||
mkdir
docs/
$$
d
;
\
test
-r
docs/
$$
d/
doxytags
||
\
echo
'<
?xml version="1.0"?>
\
<tagfile />'
>
docs/
$$
d/doxytags
;
\
if
!
test
-
r
docs/
doxytags_
$$
d
;
then
\
echo
'<?xml version="1.0"?>'
>
docs/doxytags
_
$$
d
;
\
echo
'<
tagfile />'
>>
docs/doxytags_
$$
d
;
\
fi
;
\
done
doxygen
:
built-sources empty-doxytags
@
cd
${srcdir}
;
\
for
d
in
$(DIST_SUBDIRS)
;
do
\
test
-r
${srcdir}
/
$$
d/Doxyfile
\
for
d
in
$(DIST_SUBDIRS)
$(DIST_SUBDIRS)
;
do
\
test
-r
$$
d/Doxyfile
\
&&
pushd
$$
d
>
/dev/null
\
&&
echo
running
${DOXYGEN}
in
$$
d
\
&&
${DOXYGEN}
\
&&
popd
>
/dev/null
;
\
done
;
\
done
cd
${srcdir}
/docs/html
&&
../hide_emails.sh
.PHONY
:
built-sources built-sources-am empty-doxytags doxygen
libsofia-sip-ua/bnf/Doxyfile
View file @
503410fc
PROJECT_NAME = "bnf"
OUTPUT_DIRECTORY = ../docs/html/bnf
INPUT = bnf.docs .
INPUT = bnf.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/docs/Doxyfile
View file @
503410fc
...
...
@@ -7,22 +7,22 @@ INPUT = mainpage.docs docguide.docs conformance.docs
@INCLUDE = ../docs/Doxyfile.conf
GENERATE_TAGFILE =
../docs/
doxytags_docs
GENERATE_TAGFILE = doxytags_docs
TAGFILES
=
TAGFILES +=
../docs/
doxytags_su=su
TAGFILES +=
../docs/
doxytags_ipt=ipt
TAGFILES +=
../docs/
doxytags_bnf=bnf
TAGFILES +=
../docs/
doxytags_url=url
TAGFILES +=
../docs/
doxytags_msg=msg
TAGFILES +=
../docs/
doxytags_sip=sip
TAGFILES +=
../docs/
doxytags_sresolv=sresolv
TAGFILES +=
../docs/
doxytags_stun=stun
TAGFILES +=
../docs/
doxytags_tport=tport
TAGFILES +=
../docs/
doxytags_nta=nta
TAGFILES +=
../docs/
doxytags_iptsec=iptsec
TAGFILES +=
../docs/
doxytags_sdp=sdp
TAGFILES +=
../docs/
doxytags_soa=soa
TAGFILES +=
../docs/
doxytags_nea=nea
TAGFILES +=
../docs/
doxytags_nua=nua
TAGFILES +=
../docs/
doxytags_features=features
TAGFILES =
TAGFILES += doxytags_su=su
TAGFILES += doxytags_ipt=ipt
TAGFILES += doxytags_bnf=bnf
TAGFILES += doxytags_url=url
TAGFILES += doxytags_msg=msg
TAGFILES += doxytags_sip=sip
TAGFILES += doxytags_sresolv=sresolv
TAGFILES += doxytags_stun=stun
TAGFILES += doxytags_tport=tport
TAGFILES += doxytags_nta=nta
TAGFILES += doxytags_iptsec=iptsec
TAGFILES += doxytags_sdp=sdp
TAGFILES += doxytags_soa=soa
TAGFILES += doxytags_nea=nea
TAGFILES += doxytags_nua=nua
TAGFILES += doxytags_features=features
libsofia-sip-ua/docs/Doxyfile.conf
View file @
503410fc
...
...
@@ -56,6 +56,7 @@ LATEX_BATCHMODE = YES
FILE_PATTERNS
= *.
h
*.
c
EXCLUDE_PATTERNS
=
acconfig
.
h
config
.
h
confdefs
.
h
\
test
*.
h
test
*.
c
torture
*.
c
*
test
.
c
*
torture
.
c
\
*
_
tag_dll
.
c
*
_
tag_ref
.
c
IMAGE_PATH
= ../
docs
/
pictures
libsofia-sip-ua/docs/Makefile.am
View file @
503410fc
EXTRA_DIST
=
Doxyfile Doxyfile.aliases Doxyfile.conf
\
docguide.docs
\
mainpage.docs
\
conformance.docs
\
Doxyfile.version.in
\
sofia-footer.html.in
\
hide_emails.sh
\
...
...
libsofia-sip-ua/docs/mainpage.docs
View file @
503410fc
...
...
@@ -7,7 +7,25 @@ for Sofia-SIP components. Some introductory material and
pointers to the example code are also included.
For a list of module specific pages, see @ref subdirs
"source tree structure".
"source tree structure" or direct links to submodules:<br>
<a href="nua/index.html">nua</a>
<a href="su/index.html">su</a>
<a href="features/index.html">features</a>
<a href="soa/index.html">soa</a>
<a href="sdp/index.html">sdp</a>
<a href="nta/index.html">nta</a>
<a href="tport/index.html">tport</a>
<a href="sresolv/index.html">sresolv</a>
<a href="sip/index.html">sip</a>
<a href="msg/index.html">msg</a>
<a href="url/index.html">url</a>
<a href="stun/index.html">stun</a>
<a href="iptsec/index.html">iptsec</a>
<a href="nea/index.html">nea</a>
<a href="nth/index.html">nth</a>
<a href="http/index.html">http</a>
<a href="bnf/index.html">bnf</a>
<a href="ipt/index.html">ipt</a>
@section who Contact Information
...
...
@@ -34,21 +52,23 @@ Or post to the Sofia-SIP mailing list:
In libsofia-sip-ua, there are subdirectories
Terminal and high-level libraries utilizing for both signaling and media:
- <a href="nua/index.html">"nua" - SIP User Agent library</a>
- <a href="nea/index.html">"nea" - SIP Event API</a>
- <a href="iptsec/index.html">"iptsec" -
Digest authentication for HTTP and SIP</a>
Common runtime library:
- <a href="su/index.html">"su" - sockets, memory management, threads</a>
- <a href="sresolv/index.html">"sresolv" - Asynchronous DNS resolver</a>
- <a href="ipt/index.html">"ipt" - IPT utility library</a>
SIP Signaling:
- <a href="nua/index.html">"nua" - SIP User Agent library</a>
- <a href="nea/index.html">"nea" - SIP Event API</a>
- <a href="iptsec/index.html">"iptsec" -
Digest authentication for HTTP and SIP</a>
- <a href="nta/index.html">"nta" - SIP transaction engine</a>
- <a href="sresolv/index.html">"sresolv" - Asynchronous DNS resolver</a>
- <a href="tport/index.html">"tport" - Message transport</a>
- <a href="sip/index.html">"sip" - SIP messages and headers</a>
- <a href="msg/index.html">"msg" - Message handling </a>
- <a href="ipt/index.html">"ipt" - IPT utility library</a>
- <a href="url/index.html">"url" - URL handling</a>
- <a href="bnf/index.html">"url" - low level parsing</a>
HTTP subsystem:
- <a href="nth/index.html">"nth" - HTTP protocol engine</a>
...
...
@@ -58,6 +78,12 @@ SDP processing:
- <a href="soa/index.html">"soa" - SDP Offer/Answer engine for SIP</a>
- <a href="sdp/index.html">"sdp" - SDP parser</a>
Other:
- <a href="stun/index.html">"stun" - STUN library</a>
Features provided by Sofia-SIP library:
- <a href="features/index.html">"features" - Features provided by Sofia SIP</a>
Documentation:
- "docs" - Doxygen reference documentation
...
...
libsofia-sip-ua/features/Doxyfile
View file @
503410fc
PROJECT_NAME = "features"
OUTPUT_DIRECTORY = ../docs/html/features
INPUT = features.docs .
INPUT = features.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
TAGFILES += ../docs/
docs/
doxytags
=../
docs
TAGFILES += ../docs/
su/
doxytags=../su
TAGFILES += ../docs/
ipt/
doxytags=../ipt
TAGFILES += ../docs/
bnf/
doxytags=../bnf
TAGFILES += ../docs/
url/
doxytags=../url
TAGFILES += ../docs/
msg/
doxytags=../msg
TAGFILES += ../docs/
sip/
doxytags=../sip
TAGFILES += ../docs/
sresolv/
doxytags=../sresolv
TAGFILES += ../docs/
tport/
doxytags=../tport
TAGFILES += ../docs/
nta/
doxytags=../nta
TAGFILES += ../docs/
sdp/
doxytags=../sdp
TAGFILES += ../docs/doxytags
_
docs
=..
TAGFILES += ../docs/doxytags
_su
=../su
TAGFILES += ../docs/doxytags
_ipt
=../ipt
TAGFILES += ../docs/doxytags
_bnf
=../bnf
TAGFILES += ../docs/doxytags
_url
=../url
TAGFILES += ../docs/doxytags
_msg
=../msg
TAGFILES += ../docs/doxytags
_sip
=../sip
TAGFILES += ../docs/doxytags
_sresolv
=../sresolv
TAGFILES += ../docs/doxytags
_tport
=../tport
TAGFILES += ../docs/doxytags
_nta
=../nta
TAGFILES += ../docs/doxytags
_sdp
=../sdp
GENERATE_TAGFILE = ../docs/doxytags_features
...
...
libsofia-sip-ua/features/features.c
View file @
503410fc
...
...
@@ -22,7 +22,7 @@
*
*/
/**@
file sofia_sip_
features.c
/**@
CFILE
features.c
* Provide features available through the sofia-sip library.
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
...
...
@@ -41,11 +41,14 @@
/** The name and version of software package providing Sofia-SIP-UA library. */
char
const
*
const
sofia_sip_name_version
=
SOFIA_SIP_NAME_VERSION
;
/** The name and version of software package providing S/MIME functionality. */
/** The name and version of software package providing S/MIME functionality,
* NULL if none.
*/
char
const
*
const
sofia_sip_has_smime
=
NULL
;
/** The name and version of software package providing TLS functionality.
/** The name and version of software package providing TLS functionality,
* NULL if none.
*
* TLS over TCP is used as transport for SIP messages when using SIPS
* scheme. Using TLS over TCP with SIP is described in @RFC3261.
...
...
@@ -56,14 +59,16 @@ char const * const sofia_sip_has_tls = tls_version;
char
const
*
const
sofia_sip_has_tls
;
#endif
/** The name and version of software package providing DTLS functionality.
/** The name and version of software package providing DTLS functionality,
* NULL if none.
*
* DTLS or TLS over datagram transport (UDP) can be used as transport for
* SIP messages.
*/
char
const
*
const
sofia_sip_has_dtls
;
/** The name and version of software package providing TLS over SCTP functionality.
/** The name and version of software package providing TLS over SCTP functionality,
* NULL if none.
*
* TLS over SCTP can be used as transport for SIP messages.
*/
...
...
@@ -73,7 +78,8 @@ char const * const sofia_sip_has_tls_sctp;
#include <sigcomp.h>
#endif
/** The name and version of software package providing SigComp functionality.
/** The name and version of software package providing SigComp functionality,
* NULL if none.
*
* SigComp can be used to compress SIP messages.
*/
...
...
@@ -83,7 +89,8 @@ char const * const sofia_sip_has_sigcomp = sigcomp_package_version;
char
const
*
const
sofia_sip_has_sigcomp
;
#endif
/** The name and version of software package providing STUN functionality.
/** The name and version of software package providing STUN functionality,
* NULL if none.
*
* STUN is a protocol used to traverse NATs with UDP.
*/
...
...
@@ -94,19 +101,22 @@ char const * const sofia_sip_has_stun = stun_version;
char
const
*
const
sofia_sip_has_stun
;
#endif
/** The name and version of software package providing TURN functionality.
/** The name and version of software package providing TURN functionality,
* NULL if none.
*
* TURN is a protocol used to traverse NATs or firewalls with TCP or UDP.
*/
char
const
*
const
sofia_sip_has_turn
;
/** The name and version of software package providing UPnP functionality.
/** The name and version of software package providing UPnP functionality,
* NULL if none.
*
* UPnP (Universal Plug and Play) can be used to traverse NATs or firewalls.
*/
char
const
*
const
sofia_sip_has_upnp
;
/** The name and version of software package providing SCTP functionality.
/** The name and version of software package providing SCTP functionality,
* NULL if none.
*
* SCTP can be used as transport for SIP messages. The software providing it
* can be, for example, LKSCTP (Linux kernel SCTP) for Linux.
...
...
@@ -114,7 +124,8 @@ char const * const sofia_sip_has_upnp;
char
const
*
const
sofia_sip_has_sctp
;
/* We don't have viable SCTP transport interface */
/** The name and version of software package providing IPv6 functionality.
/** The name and version of software package providing IPv6 functionality,
* NULL if none.
*
* IPv6 can be used to send SIP messages.
*/
...
...
libsofia-sip-ua/features/features.docs
View file @
503410fc
...
...
@@ -5,7 +5,7 @@
@section features_meta Module Meta Information
The @b features module provides application information about the various
features possibly available through the sofia-sip-ua binary API.
features possibly available through the
@ref subdirs "
sofia-sip-ua
"
binary API.
@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>
...
...
libsofia-sip-ua/features/sofia-sip/features.h.in
View file @
503410fc
...
...
@@ -21,7 +21,7 @@
*
*/
/**@file sofia
_
sip
_
features.h
/**@file sofia
-
sip
/
features.h
* @brief Nokia User Agent Library Features
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
...
...
@@ -30,7 +30,7 @@
*/
#ifndef SOFIA_SIP_FEATURES_H
/** Defined when <sofia
_
sip
_
features.h> has been included. */
/** Defined when <sofia
-
sip
/
features.h> has been included. */
#define SOFIA_SIP_FEATURES_H
/** Define as current Sofia version */
...
...
libsofia-sip-ua/http/Doxyfile
View file @
503410fc
PROJECT_NAME = "http"
OUTPUT_DIRECTORY = ../docs/html/http
INPUT = http.docs .
INPUT = http.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/ipt/Doxyfile
View file @
503410fc
PROJECT_NAME = "ipt"
OUTPUT_DIRECTORY = ../docs/html/ips
INPUT = ipt.docs .
INPUT = ipt.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/iptsec/Doxyfile
View file @
503410fc
PROJECT_NAME = "iptsec"
OUTPUT_DIRECTORY = ../docs/html/iptsec
INPUT = iptsec.docs .
INPUT = iptsec.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/msg/Doxyfile
View file @
503410fc
PROJECT_NAME = "msg"
OUTPUT_DIRECTORY = ../docs/html/msg
INPUT = msg.docs .
INPUT = msg.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/msg/msg_parser_util.c
View file @
503410fc
...
...
@@ -769,7 +769,7 @@ int msg_hostport_d(char **ss,
* no value for the name (in form "name" or "name=value"), the returned pointer
* points to a NUL character.
*
* @param
params list (or vector) of parameters
* @param
h pointer to header structure
* @param name parameter name (with or without "=" sign)
*
* @return
...
...
@@ -876,7 +876,7 @@ int msg_header_replace_param(su_home_t *home,
* value. The "=" and value are ignored.
*
* @param h pointer to a header
* @param
param
parameter to be removed
* @param
name name of
parameter to be removed
*
* @retval 1 if a parameter was removed
* @retval 0 if no parameter was not removed
...
...
libsofia-sip-ua/nea/Doxyfile
View file @
503410fc
PROJECT_NAME = "nea"
OUTPUT_DIRECTORY = ../docs/html/nea
INPUT = nea.docs .
INPUT = nea.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/nta/Doxyfile
View file @
503410fc
PROJECT_NAME = "nta"
OUTPUT_DIRECTORY = ../docs/html/nta
INPUT = nta.docs .
INPUT = nta.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/nth/Doxyfile
View file @
503410fc
PROJECT_NAME = "nth"
OUTPUT_DIRECTORY = ../docs/html/nth
INPUT = nth.docs .
INPUT = nth.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/nua/Doxyfile
View file @
503410fc
PROJECT_NAME = "nua"
OUTPUT_DIRECTORY = ../docs/html/nua
INPUT = nua.docs .
INPUT = nua.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/nua/sofia-sip/nua.h
View file @
503410fc
...
...
@@ -22,7 +22,7 @@
*
*/
/**@file nua.h @brief Nokia User Agent Library
/**@file
sofia-sip/
nua.h @brief Nokia User Agent Library
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
*
...
...
@@ -30,7 +30,7 @@
*/
#ifndef NUA_H
/** Defined when @b <nua.h> has been included. */
/** Defined when @b <
sofia-sip/
nua.h> has been included. */
#define NUA_H
#ifndef SU_WAIT_H
...
...
libsofia-sip-ua/sdp/Doxyfile
View file @
503410fc
PROJECT_NAME = "sdp"
OUTPUT_DIRECTORY = ../docs/html/sdp
INPUT = sdp.docs .
INPUT = sdp.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/sip/Doxyfile
View file @
503410fc
PROJECT_NAME = "sip"
OUTPUT_DIRECTORY = ../docs/html/sip
INPUT = sip.docs
.
INPUT = sip.docs
sip_parser.docs . sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
@@ -17,6 +17,7 @@ GENERATE_TAGFILE = ../docs/doxytags_sip
ALIASES += \
"SIP_TAG=@ingroup sip_tag\n" \
"SIP_HEADER=@ingroup sip_headers\n@defgroup"
"SIP_HEADER=@ingroup sip_headers\n@defgroup" \
"SIP_PARSER=\n"
IMAGE_PATH += images
libsofia-sip-ua/sip/sip_parser.docs
View file @
503410fc
...
...
@@ -37,14 +37,14 @@
*@code
/**@file sip_example.h.in
*
* Template for <sip_example.h>.
* Template for <
sofia-sip/
sip_example.h>.
*/
#ifndef SIP_EXAMPLE_H
/** Defined when <sip_example.h> has been included. */
/** Defined when <
sofia-sip/
sip_example.h> has been included. */
#define SIP_EXAMPLE_H
/**@file sip_example.h
/**@file
sofia-sip/
sip_example.h
*
* @brief Example header.
*
...
...
libsofia-sip-ua/soa/Doxyfile
View file @
503410fc
PROJECT_NAME = "soa"
OUTPUT_DIRECTORY = ../docs/html/soa
INPUT = soa.docs soa.h soa_add.h soa.c soa_tag.h soa_tag.c
INPUT = soa.docs sofia-sip/soa.h sofia-sip/soa_add.h soa.c
INPUT += sofia-sip/soa_tag.h soa_tag.c
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/sresolv/Doxyfile
View file @
503410fc
PROJECT_NAME = "sresolv"
OUTPUT_DIRECTORY = ../docs/html/sresolv
INPUT = sresolv.docs .
INPUT = sresolv.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/stun/Doxyfile
View file @
503410fc
PROJECT_NAME = "stun"
OUTPUT_DIRECTORY = ../docs/html/stun
INPUT = stun.docs .
INPUT = stun.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/stun/Makefile.am
View file @
503410fc
...
...
@@ -58,6 +58,8 @@ torture_stun_LDFLAGS = -static
# ----------------------------------------------------------------------
# Install and distribution rules
EXTRA_DIST
=
Doxyfile stun.docs cert.pem key.pem rfc3489.txt
# ----------------------------------------------------------------------
# Sofia specific rules
...
...
libsofia-sip-ua/su/Doxyfile
View file @
503410fc
PROJECT_NAME = "su"
OUTPUT_DIRECTORY = ../docs/html/su
INPUT = su.docs .
INPUT = su.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/su/su_bm.c
View file @
503410fc
...
...
@@ -23,7 +23,7 @@
*/
/**
* @file su_
memme
m.c
* @file su_
b
m.c
* @brief Search with Boyer-Moore algorithm
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
...
...
libsofia-sip-ua/tport/Doxyfile
View file @
503410fc
PROJECT_NAME = "tport"
OUTPUT_DIRECTORY = ../docs/html/tport
INPUT = tport.docs .
INPUT = tport.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/tport/Makefile.am
View file @
503410fc
...
...
@@ -38,7 +38,7 @@ endif
libtport_la_SOURCES
=
tport.c tport_tag.c tport_tag_ref.c
$(USE_TLS_SRC)
# to make sure all files end up in the dist package
EXTRA_
DIST
=
$(TLS_SRC)
EXTRA_
libtport_la_SOURCES
=
$(TLS_SRC)
BUILT_SOURCES
=
tport_tag_ref.c
...
...
@@ -57,7 +57,7 @@ test_tport_LDFLAGS = -static
# ----------------------------------------------------------------------
# Install and distribution rules
EXTRA_DIST
+
=
Doxyfile tport.docs
\
EXTRA_DIST
=
Doxyfile tport.docs
\
certificates.html agent.pem cafile.pem
# ----------------------------------------------------------------------
...
...
libsofia-sip-ua/url/Doxyfile
View file @
503410fc
PROJECT_NAME = "url"
OUTPUT_DIRECTORY = ../docs/html/url
INPUT = url.docs .
INPUT = url.docs .
sofia-sip
@INCLUDE = ../docs/Doxyfile.conf
...
...
libsofia-sip-ua/url/sofia-sip/url.h
View file @
503410fc
...
...
@@ -54,8 +54,8 @@ enum url_type_e {
url_im
,
/**< @c "im:" (simple instant messaging) */
url_pres
,
/**< @c "pres:" (simple presence) */
url_cid
,
/**< @c "cid:" (Content-ID) */
url_msrp
,
/**< @
<
"msrp:" (message session relay) */
url_wv
,
/**< @
<
"wv:" (Wireless village) */
url_msrp
,
/**< @
c
"msrp:" (message session relay) */
url_wv
,
/**< @
c
"wv:" (Wireless village) */
_url_none
};
...
...
libsofia-sip-ua/url/url.docs
View file @
503410fc
...
...
@@ -25,46 +25,54 @@ The formal URI syntax is defined in the
The URLs consist of a subset of printable ASCII (ECMA-5) characters. The
subset excludes space and characters commonly used as @e delimiters in
text-based protocols, such as "<" ">" "#" "%" and <"> (double quote), and so
called @e unwise characters whose positions are reserved for national
extensions in ECMA-5 (in US-ASCII, those characters are "{" "}" "|" "\" "^"
"[" "]" and "`").
text-based protocols, such as <b> < > # \% </b>and<b> " </b> (double
quote), and so called @e unwise characters whose positions are reserved for
national extensions in ECMA-5. In US-ASCII, those characters are:
<code><b>
{ } | \ ^ [ ] `
</b></code>
There are also nine characters that can have special syntactic meaning in
some parts of the URI. These @e reserved characters are used to separate