Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
L
libnice
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
cpp-libs
libnice
Commits
275e1b5d
Commit
275e1b5d
authored
Mar 06, 2014
by
Olivier Crête
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc: Update doc generation
parent
810b722d
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
109 additions
and
21 deletions
+109
-21
docs/reference/libnice/Makefile.am
docs/reference/libnice/Makefile.am
+19
-16
docs/reference/libnice/libnice-docs.sgml
docs/reference/libnice/libnice-docs.sgml
+47
-1
docs/reference/libnice/libnice-sections.txt
docs/reference/libnice/libnice-sections.txt
+43
-4
No files found.
docs/reference/libnice/Makefile.am
View file @
275e1b5d
...
@@ -13,7 +13,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
...
@@ -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
# gtk-doc will search all .c & .h files beneath here for inline comments
# documenting the functions and macros.
# documenting the functions and macros.
# e.g. DOC_SOURCE_DIR=../../../gtk
# 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.
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
SCANGOBJ_OPTIONS
=
SCANGOBJ_OPTIONS
=
...
@@ -37,24 +37,27 @@ FIXXREF_OPTIONS=
...
@@ -37,24 +37,27 @@ FIXXREF_OPTIONS=
# Used for dependencies. The docs will be rebuilt if any of these change.
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB
=
$(
DOC_SOURCE_DIR)
/agent/agent.h
$(DOC_SOURCE_DIR
)
/agent/address.h
\
HFILE_GLOB
=
$(
top_srcdir)
/agent/agent.h
$(top_srcdir
)
/agent/address.h
\
$(
DOC_SOURCE_DIR)
/agent/debug.h
$(DOC_SOURCE_DIR
)
/agent/candidate.h
\
$(
top_srcdir)
/agent/debug.h
$(top_srcdir
)
/agent/candidate.h
\
$(
DOC_SOURCE_DIR
)
/agent/interfaces.h
\
$(
top_srcdir
)
/agent/interfaces.h
\
$(
DOC_SOURCE_DIR)
/stun/stunagent.h
\
$(
top_srcdir)
/agent/pseudotcp.h
\
$(
DOC_SOURCE_DIR)
/stun/stunmessage.h
$(
top_srcdir)
/stun/stunagent.h
\
$(
DOC_SOURCE_DIR)/stun/debug
.h
\
$(
top_srcdir)
/stun/stunmessage
.h
\
$(
DOC_SOURCE_DIR)/stun/usages/bind
.h
\
$(
top_srcdir)
/stun/debug
.h
\
$(
DOC_SOURCE_DIR)/stun/usages/ice
.h
\
$(
top_srcdir)
/stun/usages/bind
.h
\
$(
DOC_SOURCE_DIR)/stun/usages/timer
.h
\
$(
top_srcdir)
/stun/usages/ice
.h
\
$(
DOC_SOURCE_DIR)/stun/usages/turn
.h
\
$(
top_srcdir)
/stun/usages/timer
.h
\
$(
DOC_SOURCE_DIR)/agent/pseudotcp
.h
$(
top_srcdir)
/stun/usages/turn
.h
CFILE_GLOB
=
$(
DOC_SOURCE_DIR
)
/agent/agent.c
\
CFILE_GLOB
=
$(
top_srcdir
)
/agent/agent.c
\
$(
DOC_SOURCE_DIR
)
/agent/pseudotcp.c
$(
top_srcdir
)
/agent/pseudotcp.c
# Header files to ignore when scanning.
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
# 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.
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
...
...
docs/reference/libnice/libnice-docs.sgml
View file @
275e1b5d
...
@@ -29,7 +29,8 @@
...
@@ -29,7 +29,8 @@
<chapter>
<chapter>
<xi:include
href=
"xml/stunagent.xml"
/>
<xi:include
href=
"xml/stunagent.xml"
/>
<xi:include
href=
"xml/stunmessage.xml"
/>
<xi:include
href=
"xml/stunmessage.xml"
/>
</chapter>
<xi:include
href=
"xml/stunconstants.xml"
/>
</chapter>
<chapter>
<chapter>
<title>
STUN usages
</title>
<title>
STUN usages
</title>
<xi:include
href=
"xml/bind.xml"
/>
<xi:include
href=
"xml/bind.xml"
/>
...
@@ -49,4 +50,49 @@
...
@@ -49,4 +50,49 @@
<para>
The libnice library contains the ICE library and the
<para>
The libnice library contains the ICE library and the
STUN library as well as a Pseudo TCP socket implementation.
STUN library as well as a Pseudo TCP socket implementation.
</para>
</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>
</book>
docs/reference/libnice/libnice-sections.txt
View file @
275e1b5d
...
@@ -8,6 +8,7 @@ NiceProxyType
...
@@ -8,6 +8,7 @@ NiceProxyType
NiceCompatibility
NiceCompatibility
NiceAgentRecvFunc
NiceAgentRecvFunc
NiceInputMessage
NiceInputMessage
NiceOutputMessage
NICE_AGENT_MAX_REMOTE_CANDIDATES
NICE_AGENT_MAX_REMOTE_CANDIDATES
nice_agent_new
nice_agent_new
nice_agent_new_reliable
nice_agent_new_reliable
...
@@ -111,9 +112,6 @@ nice_address_ip_version
...
@@ -111,9 +112,6 @@ nice_address_ip_version
<TITLE>Debug messages</TITLE>
<TITLE>Debug messages</TITLE>
nice_debug_enable
nice_debug_enable
nice_debug_disable
nice_debug_disable
<SUBSECTION Private>
nice_debug_init
nice_debug
</SECTION>
</SECTION>
<SECTION>
<SECTION>
...
@@ -185,6 +183,8 @@ stun_message_append_xor_addr
...
@@ -185,6 +183,8 @@ stun_message_append_xor_addr
stun_message_append_xor_addr_full
stun_message_append_xor_addr_full
stun_message_append_error
stun_message_append_error
stun_message_validate_buffer_length
stun_message_validate_buffer_length
StunInputVector
stun_message_validate_buffer_length_fast
stun_message_id
stun_message_id
stun_message_get_class
stun_message_get_class
stun_message_get_method
stun_message_get_method
...
@@ -194,7 +194,32 @@ stun_optional
...
@@ -194,7 +194,32 @@ stun_optional
stun_strerror
stun_strerror
</SECTION>
</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>
<SECTION>
<FILE>turn</FILE>
<FILE>turn</FILE>
...
@@ -206,6 +231,7 @@ stun_usage_turn_create
...
@@ -206,6 +231,7 @@ stun_usage_turn_create
stun_usage_turn_create_refresh
stun_usage_turn_create_refresh
stun_usage_turn_process
stun_usage_turn_process
stun_usage_turn_refresh_process
stun_usage_turn_refresh_process
stun_usage_turn_create_permission
</SECTION>
</SECTION>
<SECTION>
<SECTION>
...
@@ -265,4 +291,17 @@ pseudo_tcp_socket_notify_packet
...
@@ -265,4 +291,17 @@ pseudo_tcp_socket_notify_packet
pseudo_tcp_set_debug_level
pseudo_tcp_set_debug_level
pseudo_tcp_socket_get_available_bytes
pseudo_tcp_socket_get_available_bytes
pseudo_tcp_socket_can_send
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>
</SECTION>
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment