e3e0966f21b02e44892bd7af6cd0c06712db8915
[platform/upstream/libnice.git] / docs / reference / libnice / libnice-docs.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
5   <bookinfo>
6     <title>libnice Reference Manual</title>
7     <releaseinfo>
8       The latest version of this documentation can be found on-line at
9       <ulink role="online-location" url="http://nice.freedesktop.org/libnice/index.html">http://nice.freedesktop.org/libnice/</ulink>.
10     </releaseinfo>
11   </bookinfo>
12
13
14   <part>
15     <title>ICE Library</title>
16     <chapter>
17       <xi:include href="xml/agent.xml"/>
18       <xi:include href="xml/address.xml"/>
19       <xi:include href="xml/candidate.xml"/>
20     </chapter>
21     <chapter>
22       <title>Libnice helper functions</title>
23       <xi:include href="xml/debug.xml"/>
24       <xi:include href="xml/interfaces.xml"/>
25     </chapter>
26   </part>
27   <part>
28     <title>STUN Library</title>
29     <chapter>
30       <xi:include href="xml/stunagent.xml"/>
31       <xi:include href="xml/stunmessage.xml"/>
32       <xi:include href="xml/stunconstants.xml"/>
33    </chapter>
34     <chapter>
35       <title>STUN usages</title>
36       <xi:include href="xml/bind.xml"/>
37       <xi:include href="xml/ice.xml"/>
38       <xi:include href="xml/turn.xml"/>
39       <xi:include href="xml/timer.xml"/>
40     </chapter>
41   </part>
42
43   <part>
44     <title>Pseudo TCP Socket implementation</title>
45     <chapter>
46       <xi:include href="xml/pseudotcp.xml"/>
47     </chapter>
48   </part>
49
50   <para>The libnice library contains the ICE library and the
51     STUN library as well as a Pseudo TCP socket implementation.
52   </para>
53
54   <part>
55     <title>Appendices</title>
56     <index id="api-index-full">
57       <title>API Index</title>
58       <xi:include href="xml/api-index-full.xml"><xi:fallback/></xi:include>
59     </index>
60     <index id="api-index-deprecated">
61       <title>Index of deprecated symbols</title>
62       <xi:include href="xml/api-index-deprecated.xml"><xi:fallback/></xi:include>
63     </index>
64     <index role="0.0.4">
65       <title>Index of new symbols in 0.0.4</title>
66       <xi:include href="xml/api-index-0.0.4.xml"><xi:fallback/></xi:include>
67     </index>
68     <index role="0.0.6">
69       <title>Index of new symbols in 0.0.6</title>
70       <xi:include href="xml/api-index-0.0.6.xml"><xi:fallback/></xi:include>
71     </index>
72     <index role="0.0.7">
73       <title>Index of new symbols in 0.0.7</title>
74       <xi:include href="xml/api-index-0.0.7.xml"><xi:fallback/></xi:include>
75     </index>
76     <index role="0.0.9">
77       <title>Index of new symbols in 0.0.9</title>
78       <xi:include href="xml/api-index-0.0.9.xml"><xi:fallback/></xi:include>
79     </index>
80     <index role="0.0.10">
81       <title>Index of new symbols in 0.0.10</title>
82       <xi:include href="xml/api-index-0.0.10.xml"><xi:fallback/></xi:include>
83     </index>
84     <index role="0.0.11">
85       <title>Index of new symbols in 0.0.11</title>
86       <xi:include href="xml/api-index-0.0.11.xml"><xi:fallback/></xi:include>
87     </index>
88     <index role="0.1.4">
89       <title>Index of new symbols in 0.1.4</title>
90       <xi:include href="xml/api-index-0.1.4.xml"><xi:fallback/></xi:include>
91     </index>
92     <index role="0.1.5">
93       <title>Index of new symbols in 0.1.5</title>
94       <xi:include href="xml/api-index-0.1.5.xml"><xi:fallback/></xi:include>
95     </index>
96     <index role="0.1.6">
97       <title>Index of new symbols in 0.1.6</title>
98       <xi:include href="xml/api-index-0.1.6.xml"><xi:fallback/></xi:include>
99     </index>
100     <index role="0.1.8">
101       <title>Index of new symbols in 0.1.8</title>
102       <xi:include href="xml/api-index-0.1.8.xml"><xi:fallback/></xi:include>
103     </index>
104     <index role="0.1.14">
105       <title>Index of new symbols in 0.1.14</title>
106       <xi:include href="xml/api-index-0.1.14.xml"><xi:fallback/></xi:include>
107     </index>
108     <index role="0.1.15">
109       <title>Index of new symbols in 0.1.15</title>
110       <xi:include href="xml/api-index-0.1.15.xml"><xi:fallback/></xi:include>
111     </index>
112     <index role="0.1.16">
113       <title>Index of new symbols in 0.1.16</title>
114       <xi:include href="xml/api-index-0.1.16.xml"><xi:fallback/></xi:include>
115     </index>
116     <index role="0.1.17">
117       <title>Index of new symbols in 0.1.17</title>
118       <xi:include href="xml/api-index-0.1.17.xml"><xi:fallback/></xi:include>
119     </index>
120     <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
121   </part>
122 </book>