diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 4 | ||||
| -rw-r--r-- | docs/reference/Makefile.am | 2 | ||||
| -rw-r--r-- | docs/reference/libnice/Makefile.am | 89 | ||||
| -rw-r--r-- | docs/reference/libnice/libnice-docs.sgml | 21 | ||||
| -rw-r--r-- | docs/reference/libnice/libnice-sections.txt | 92 | ||||
| -rw-r--r-- | docs/reference/libstun/Makefile.am | 87 |
6 files changed, 295 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..fcd5f1b --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,4 @@ + +SUBDIRS = reference + +EXTRA_DIST = design.txt diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..9de09e5 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,2 @@ + +SUBDIRS = libnice libstun diff --git a/docs/reference/libnice/Makefile.am b/docs/reference/libnice/Makefile.am new file mode 100644 index 0000000..63cd82d --- /dev/null +++ b/docs/reference/libnice/Makefile.am @@ -0,0 +1,89 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libnice + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# 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)/agent + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--rebuild-types + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +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.h $(DOC_SOURCE_DIR)/address.h $(DOC_SOURCE_DIR)/debug.h $(DOC_SOURCE_DIR)/candidate.h +CFILE_GLOB= + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= conncheck.h discovery.h stream.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +AM_CFLAGS = $(ERROR_CFLAGS) \ + $(GLIB_CFLAGS) \ + -I $(top_srcdir) \ + -I $(top_srcdir)/random \ + -I $(top_srcdir)/socket \ + -I $(top_srcdir)/stun + +GTKDOC_LIBS= $(top_builddir)/agent/libagent.la $(GLIB_LIBS) + + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +TESTS = $(GTKDOC_CHECK) + diff --git a/docs/reference/libnice/libnice-docs.sgml b/docs/reference/libnice/libnice-docs.sgml new file mode 100644 index 0000000..dc0d6fa --- /dev/null +++ b/docs/reference/libnice/libnice-docs.sgml @@ -0,0 +1,21 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>libnice Reference Manual</title> + <releaseinfo> + for libnice 0.0.1 + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://nice.freedesktop.org/libnice/index.html">http://nice.freedesktop.org/libnice/</ulink>. + </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"/> + </chapter> +</book> diff --git a/docs/reference/libnice/libnice-sections.txt b/docs/reference/libnice/libnice-sections.txt new file mode 100644 index 0000000..94208b9 --- /dev/null +++ b/docs/reference/libnice/libnice-sections.txt @@ -0,0 +1,92 @@ +<SECTION> +<FILE>agent</FILE> +NICE_AGENT_MAX_REMOTE_CANDIDATES +NiceComponentState +NiceComponentType +NiceCompatibility +NiceAgentRecvFunc +<TITLE>NiceAgent</TITLE> +NiceAgent +nice_agent_new +nice_agent_add_local_address +nice_agent_add_stream +nice_agent_remove_stream +nice_agent_set_relay_info +nice_agent_gather_candidates +nice_agent_set_remote_credentials +nice_agent_get_local_credentials +nice_agent_add_remote_candidate +nice_agent_set_remote_candidates +nice_agent_send +nice_agent_get_local_candidates +nice_agent_get_remote_candidates +nice_agent_restart +nice_agent_attach_recv +nice_agent_set_selected_pair +nice_agent_set_selected_remote_candidate +<SUBSECTION Standard> +NICE_AGENT +NICE_IS_AGENT +NICE_TYPE_AGENT +nice_agent_get_type +NICE_AGENT_CLASS +NICE_IS_AGENT_CLASS +NICE_AGENT_GET_CLASS +<SUBSECTION Private> +</SECTION> + +<SECTION> +<FILE>debug</FILE> +<TITLE>Debug messages</TITLE> +nice_debug_enable +nice_debug_disable +<SUBSECTION Private> +nice_debug_init +nice_debug +</SECTION> + +<SECTION> +<FILE>candidate</FILE> +<TITLE>NiceCandidate</TITLE> +NICE_CANDIDATE_MAX_FOUNDATION +NiceCandidateType +NiceCandidateTransport +NiceRelayType +NiceCandidate +TurnServer +nice_candidate_new +nice_candidate_free +nice_candidate_copy +<SUBSECTION Private> +NICE_CANDIDATE_TYPE_PREF_HOST +NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE +NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE +NICE_CANDIDATE_TYPE_PREF_RELAYED +nice_candidate_jingle_priority +nice_candidate_msn_priority +nice_candidate_ice_priority_full +nice_candidate_ice_priority +nice_candidate_pair_priority +</SECTION> + + +<SECTION> +<FILE>address</FILE> +<TITLE>NiceAddress</TITLE> +NICE_ADDRESS_STRING_LEN +NiceAddress +nice_address_new +nice_address_free +nice_address_dup +nice_address_set_ipv4 +nice_address_set_ipv6 +nice_address_set_port +nice_address_get_port +nice_address_set_from_string +nice_address_set_from_sockaddr +nice_address_copy_to_sockaddr +nice_address_equal +nice_address_to_string +nice_address_is_private +nice_address_is_valid +</SECTION> diff --git a/docs/reference/libstun/Makefile.am b/docs/reference/libstun/Makefile.am new file mode 100644 index 0000000..6b5686c --- /dev/null +++ b/docs/reference/libstun/Makefile.am @@ -0,0 +1,87 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libstun + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# 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)/stun + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +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)/*.h $(DOC_SOURCE_DIR)/usages/*.h +CFILE_GLOB= $(DOC_SOURCE_DIR)/*.c $(DOC_SOURCE_DIR)/usages/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +TESTS = $(GTKDOC_CHECK) + |