Commit 275e1b5d authored by Olivier Crête's avatar Olivier Crête

doc: Update doc generation

parent 810b722d
......@@ -13,7 +13,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
DOC_SOURCE_DIR=$(top_srcdir)
DOC_SOURCE_DIR=$(top_srcdir)/agent $(top_srcdir)/stun
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS=
......@@ -37,24 +37,27 @@ FIXXREF_OPTIONS=
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB=$(DOC_SOURCE_DIR)/agent/agent.h $(DOC_SOURCE_DIR)/agent/address.h \
$(DOC_SOURCE_DIR)/agent/debug.h $(DOC_SOURCE_DIR)/agent/candidate.h \
$(DOC_SOURCE_DIR)/agent/interfaces.h \
$(DOC_SOURCE_DIR)/stun/stunagent.h \
$(DOC_SOURCE_DIR)/stun/stunmessage.h
$(DOC_SOURCE_DIR)/stun/debug.h \
$(DOC_SOURCE_DIR)/stun/usages/bind.h \
$(DOC_SOURCE_DIR)/stun/usages/ice.h \
$(DOC_SOURCE_DIR)/stun/usages/timer.h \
$(DOC_SOURCE_DIR)/stun/usages/turn.h \
$(DOC_SOURCE_DIR)/agent/pseudotcp.h
CFILE_GLOB=$(DOC_SOURCE_DIR)/agent/agent.c \
$(DOC_SOURCE_DIR)/agent/pseudotcp.c
HFILE_GLOB=$(top_srcdir)/agent/agent.h $(top_srcdir)/agent/address.h \
$(top_srcdir)/agent/debug.h $(top_srcdir)/agent/candidate.h \
$(top_srcdir)/agent/interfaces.h \
$(top_srcdir)/agent/pseudotcp.h \
$(top_srcdir)/stun/stunagent.h \
$(top_srcdir)/stun/stunmessage.h \
$(top_srcdir)/stun/debug.h \
$(top_srcdir)/stun/usages/bind.h \
$(top_srcdir)/stun/usages/ice.h \
$(top_srcdir)/stun/usages/timer.h \
$(top_srcdir)/stun/usages/turn.h
CFILE_GLOB=$(top_srcdir)/agent/agent.c \
$(top_srcdir)/agent/pseudotcp.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES= conncheck.h discovery.h stream.h gstnice.h gstnicesrc.h gstnicesink.h component.h iostream.h inputstream.h outputstream.h
IGNORE_HFILES= conncheck.h discovery.h stream.h component.h agent-priv.h \
agent-signals-marshal.h iostream.h inputstream.h outputstream.h \
gstnice.h gstnicesrc.h gstnicesink.h \
md5.h sha1.h stunhmac.h utils.h rand.h stun5389.h stuncrc32.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
......
......@@ -29,7 +29,8 @@
<chapter>
<xi:include href="xml/stunagent.xml"/>
<xi:include href="xml/stunmessage.xml"/>
</chapter>
<xi:include href="xml/stunconstants.xml"/>
</chapter>
<chapter>
<title>STUN usages</title>
<xi:include href="xml/bind.xml"/>
......@@ -49,4 +50,49 @@
<para>The libnice library contains the ICE library and the
STUN library as well as a Pseudo TCP socket implementation.
</para>
<part>
<title>Appendices</title>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback/></xi:include>
</index>
<index id="api-index-deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback/></xi:include>
</index>
<index role="0.0.4">
<title>Index of new symbols in 0.0.4</title>
<xi:include href="xml/api-index-0.0.4.xml"><xi:fallback/></xi:include>
</index>
<index role="0.0.6">
<title>Index of new symbols in 0.0.6</title>
<xi:include href="xml/api-index-0.0.6.xml"><xi:fallback/></xi:include>
</index>
<index role="0.0.7">
<title>Index of new symbols in 0.0.7</title>
<xi:include href="xml/api-index-0.0.7.xml"><xi:fallback/></xi:include>
</index>
<index role="0.0.9">
<title>Index of new symbols in 0.0.9</title>
<xi:include href="xml/api-index-0.0.9.xml"><xi:fallback/></xi:include>
</index>
<index role="0.0.10">
<title>Index of new symbols in 0.0.10</title>
<xi:include href="xml/api-index-0.0.10.xml"><xi:fallback/></xi:include>
</index>
<index role="0.0.11">
<title>Index of new symbols in 0.0.11</title>
<xi:include href="xml/api-index-0.0.11.xml"><xi:fallback/></xi:include>
</index>
<index role="0.1.4">
<title>Index of new symbols in 0.1.4</title>
<xi:include href="xml/api-index-0.1.4.xml"><xi:fallback/></xi:include>
</index>
<index role="0.1.5">
<title>Index of new symbols in 0.1.5</title>
<xi:include href="xml/api-index-0.1.5.xml"><xi:fallback/></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</part>
</book>
......@@ -8,6 +8,7 @@ NiceProxyType
NiceCompatibility
NiceAgentRecvFunc
NiceInputMessage
NiceOutputMessage
NICE_AGENT_MAX_REMOTE_CANDIDATES
nice_agent_new
nice_agent_new_reliable
......@@ -111,9 +112,6 @@ nice_address_ip_version
<TITLE>Debug messages</TITLE>
nice_debug_enable
nice_debug_disable
<SUBSECTION Private>
nice_debug_init
nice_debug
</SECTION>
<SECTION>
......@@ -185,6 +183,8 @@ stun_message_append_xor_addr
stun_message_append_xor_addr_full
stun_message_append_error
stun_message_validate_buffer_length
StunInputVector
stun_message_validate_buffer_length_fast
stun_message_id
stun_message_get_class
stun_message_get_method
......@@ -194,7 +194,32 @@ stun_optional
stun_strerror
</SECTION>
<SECTION>
<FILE>stunconstants</FILE>
<TITLE>STUN Constants</TITLE>
STUN_AGENT_MAX_SAVED_IDS
STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES
STUN_ATTRIBUTE_HEADER_LENGTH
STUN_ATTRIBUTE_LENGTH_LEN
STUN_ATTRIBUTE_LENGTH_POS
STUN_ATTRIBUTE_TYPE_LEN
STUN_ATTRIBUTE_TYPE_POS
STUN_ATTRIBUTE_VALUE_POS
STUN_ID_LEN
STUN_MAGIC_COOKIE
STUN_MAX_MESSAGE_SIZE
STUN_MAX_MESSAGE_SIZE_IPV4
STUN_MAX_MESSAGE_SIZE_IPV6
STUN_MESSAGE_ATTRIBUTES_POS
STUN_MESSAGE_HEADER_LENGTH
STUN_MESSAGE_LENGTH_LEN
STUN_MESSAGE_LENGTH_POS
STUN_MESSAGE_TRANS_ID_LEN
STUN_MESSAGE_TRANS_ID_POS
STUN_MESSAGE_TYPE_LEN
STUN_MESSAGE_TYPE_POS
TURN_MAGIC_COOKIE
</SECTION>
<SECTION>
<FILE>turn</FILE>
......@@ -206,6 +231,7 @@ stun_usage_turn_create
stun_usage_turn_create_refresh
stun_usage_turn_process
stun_usage_turn_refresh_process
stun_usage_turn_create_permission
</SECTION>
<SECTION>
......@@ -265,4 +291,17 @@ pseudo_tcp_socket_notify_packet
pseudo_tcp_set_debug_level
pseudo_tcp_socket_get_available_bytes
pseudo_tcp_socket_can_send
pseudo_tcp_socket_get_available_send_space
pseudo_tcp_socket_notify_message
<SUBSECTION Standard>
pseudo_tcp_socket_get_type
PseudoTcpSocketClass
PSEUDOTCP_SOCKET_GET_CLASS
PSEUDO_TCP_SOCKET
PSEUDO_TCP_SOCKET_CLASS
PSEUDO_TCP_SOCKET_TYPE
IS_PSEUDO_TCP_SOCKET
IS_PSEUDO_TCP_SOCKET_CLASS
<SUBSECTION Private>
PseudoTcpSocketPrivate
</SECTION>
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