summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYouness Alaoui <youness.alaoui@collabora.co.uk>2009-03-02 17:53:38 -0500
committerYouness Alaoui <youness.alaoui@collabora.co.uk>2009-03-02 17:53:38 -0500
commitcf920a85359874320bd8855456df377bac207324 (patch)
tree1d28c5393236f6e522f3cdf9bb99fc7222e7f69e /docs
parente6b909de1952609694a2b886ce4d217f41f9708d (diff)
downloadlibnice-cf920a85359874320bd8855456df377bac207324.tar.gz
Update docs, finish formatting the gtk-doc and add the STUN API to the exported symbols list
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/libnice/libnice-docs.sgml47
1 files changed, 33 insertions, 14 deletions
diff --git a/docs/reference/libnice/libnice-docs.sgml b/docs/reference/libnice/libnice-docs.sgml
index decfad5..f53cf1d 100644
--- a/docs/reference/libnice/libnice-docs.sgml
+++ b/docs/reference/libnice/libnice-docs.sgml
@@ -10,18 +10,37 @@
</releaseinfo>
</bookinfo>
- <chapter>
- <title>libnice's public API</title>
- <xi:include href="xml/agent.xml"/>
- <xi:include href="xml/address.xml"/>
- <xi:include href="xml/debug.xml"/>
- <xi:include href="xml/candidate.xml"/>
- <xi:include href="xml/interfaces.xml"/>
- <xi:include href="xml/stunagent.xml"/>
- <xi:include href="xml/stunmessage.xml"/>
- <xi:include href="xml/turn.xml"/>
- <xi:include href="xml/bind.xml"/>
- <xi:include href="xml/ice.xml"/>
- <xi:include href="xml/timer.xml"/>
- </chapter>
+
+ <part>
+ <title>ICE Library</title>
+ <chapter>
+ <xi:include href="xml/agent.xml"/>
+ <xi:include href="xml/address.xml"/>
+ <xi:include href="xml/candidate.xml"/>
+ </chapter>
+ <chapter>
+ <title>Libnice helper functions </title>
+ <xi:include href="xml/debug.xml"/>
+ <xi:include href="xml/interfaces.xml"/>
+ </chapter>
+ </part>
+ <part>
+ <title>STUN Library</title>
+ <chapter>
+ <xi:include href="xml/stunagent.xml"/>
+ <xi:include href="xml/stunmessage.xml"/>
+ </chapter>
+ <chapter>
+ <title>STUN usages</title>
+ <xi:include href="xml/bind.xml"/>
+ <xi:include href="xml/ice.xml"/>
+ <xi:include href="xml/turn.xml"/>
+ <xi:include href="xml/timer.xml"/>
+ </chapter>
+ </part>
+
+
+ <para>The libnice library contains both the ICE library and the
+ STUN library.
+ </para>
</book>