docs: Add gtk-doc build system

8 files changed, 440 insertions, 0 deletions

diff --git a/Makefile.am b/Makefile.am
index 6936b37..cd0de82 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -6,6 +6,7 @@ SUBDIRS = 		\
 	m4   		\
 	common \
 	pkgconfig \
+	docs \
 	examples
 
 DIST_SUBDIRS = $(SUBDIRS)
diff --git a/configure.ac b/configure.ac
index 27bfdaa..3c225d0 100644
--- a/configure.ac
+++ b/configure.ac
@@ -297,6 +297,9 @@ bindings/vala/Makefile
 pkgconfig/Makefile
 pkgconfig/gst-rtsp-server.pc
 pkgconfig/gst-rtsp-server-uninstalled.pc
+docs/Makefile
+docs/version.entities
+docs/libs/Makefile
 ])
 AC_OUTPUT
 
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..f782512
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,11 @@
+if ENABLE_GTK_DOC
+DOCS_SUBDIRS = libs
+else
+DOCS_SUBDIRS = 
+endif
+
+SUBDIRS = $(DOCS_SUBDIRS)
+DIST_SUBDIRS = libs
+
+EXTRA_DIST = \
+	version.entities.in
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
new file mode 100644
index 0000000..71ac2e0
--- /dev/null
+++ b/docs/libs/Makefile.am
@@ -0,0 +1,105 @@
+GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
+
+## Process this file with automake to produce Makefile.in
+
+# The name of the module, e.g. 'glib'.
+MODULE=gst-rtsp-server
+DOC_MODULE=$(MODULE)
+
+# for upload-doc.mak
+DOC=$(MODULE)
+FORMATS=html ps pdf
+html: html-build.stamp
+include $(top_srcdir)/common/upload-doc.mak
+
+# generated basefiles
+#basefiles = \
+##		$(DOC_MODULE).types \
+#		$(DOC_MODULE)-sections.txt \
+#		$(DOC_MODULE)-docs.sgml
+
+# ugly hack to make -unused.sgml work
+#unused-build.stamp:
+#	BUILDDIR=`pwd` && \
+#	cd $(srcdir)/tmpl && \
+#	ln -sf gstreamer-libs-unused.sgml \
+#		$$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
+#	touch unused-build.stamp
+
+# these rules are added to create parallel docs using GST_MAJORMINOR
+#$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
+#	cp $< $@
+
+#CLEANFILES = $(basefiles)
+
+# The top-level SGML file. Change it if you want.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(top_srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting functions and macros.
+DOC_SOURCE_DIR = $(top_srcdir)/gst/rtsp-server/
+DOC_BUILD_DIR=$(top_builddir)/gst/rtsp-server/
+
+SCAN_OPTIONS= 
+
+# FIXME :
+# there's something wrong with gstreamer-sections.txt not being in the dist
+# maybe it doesn't resolve; we're adding it below for now
+#EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc,m
+
+# Extra options to supply to gtkdoc-fixref.
+FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
+	--extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
+	--extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
+
+# Used for dependencies.
+HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
+CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
+
+SCANOBJ_DEPS = \
+	$(top_builddir)/gst/rtsp-server/libgstrtspserver-@GST_MAJORMINOR@.la
+
+# Extra options to supply to gtkdoc-scan.
+SCANOBJ_OPTIONS=--type-init-func="g_type_init();gst_init(&argc,&argv)"
+
+# Header files to ignore when scanning.
+IGNORE_HFILES = 
+IGNORE_CFILES =
+
+# we add all .h files of elements that have signals/args we want
+# sadly this also pulls in the private methods - maybe we should
+# move those around in the source ?
+# also, we should add some stuff here conditionally based on whether
+# or not the plugin will actually build
+# but I'm not sure about that - it might be this Just Works given that
+# the registry won't have the element
+
+EXTRA_HFILES = 
+
+# Images to copy into HTML directory.
+HTML_IMAGES =
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+content_files = 
+
+# Other files to distribute.
+extra_files =
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
+# contains GtkObjects/GObjects and you want to document signals and properties.
+GTKDOC_CFLAGS = -I$(top_srcdir) $(GST_BASE_CFLAGS) $(GST_CFLAGS) $(GST_PBUTILS_CFLAGS)
+GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS) $(GST_LIBS)
+
+GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
+GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
+
+# If you need to override some of the declarations, place them in this file
+# and uncomment this line.
+#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
+DOC_OVERRIDES =
+
+include $(top_srcdir)/common/gtk-doc.mak
diff --git a/docs/libs/gst-rtsp-server-docs.sgml b/docs/libs/gst-rtsp-server-docs.sgml
new file mode 100644
index 0000000..7412dbc
--- /dev/null
+++ b/docs/libs/gst-rtsp-server-docs.sgml
@@ -0,0 +1,88 @@
+<?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" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+]>
+
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>GStreamer RTSP Server Reference Manual</title>
+    <releaseinfo>
+      for GStreamer RTSP Server &GST_MAJORMINOR;
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <xi:include href="xml/rtsp-client.xml"/>
+    <xi:include href="xml/rtsp-media-factory.xml"/>
+    <xi:include href="xml/rtsp-media-mapping.xml"/>
+    <xi:include href="xml/rtsp-media.xml"/>
+    <xi:include href="xml/rtsp-params.xml"/>
+    <xi:include href="xml/rtsp-sdp.xml"/>
+    <xi:include href="xml/rtsp-server.xml"/>
+    <xi:include href="xml/rtsp-session-pool.xml"/>
+    <xi:include href="xml/rtsp-session.xml"/>
+  </chapter>
+
+  <!-- <chapter> -->
+  <!--   <title>Base Classes</title> -->
+  <!--   <xi:include href="xml/ges-timeline.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-layer.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-object.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-overlay.xml"/> -->
+  <!--   <xi:include href="xml/ges-track.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-object.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-operation.xml"/> -->
+  <!-- </chapter> -->
+
+  <!-- <chapter> -->
+  <!--   <title>Timeline objects</title> -->
+  <!--   <xi:include href="xml/ges-timeline-filesource.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-title-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-test-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-text-overlay.xml"/> -->
+  <!--   <xi:include href="xml/ges-timeline-transition.xml"/> -->
+  <!-- </chapter> -->
+
+  <!-- <chapter> -->
+  <!--   <title>Track objects</title> -->
+  <!--   <xi:include href="xml/ges-track-filesource.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-title-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-audio-test-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-video-test-source.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-text-overlay.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-transition.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-video-transition.xml"/> -->
+  <!--   <xi:include href="xml/ges-track-audio-transition.xml"/> -->
+  <!-- </chapter> -->
+
+  <!-- <chapter> -->
+  <!--   <title>Simple Timeline interface</title> -->
+  <!--   <xi:include href="xml/ges-simple-timeline-layer.xml"/> -->
+  <!-- </chapter> -->
+
+  <!-- <chapter> -->
+  <!--   <title>Convenience classes</title> -->
+  <!--   <xi:include href="xml/ges-timeline-pipeline.xml"/> -->
+  <!--   <xi:include href="xml/ges-custom-timeline-source.xml"/> -->
+  <!-- </chapter> -->
+
+  <!-- <chapter> -->
+  <!--   <title>Serialization Classes</title> -->
+  <!--   <xi:include href="xml/ges-formatter.xml"/> -->
+  <!--   <xi:include href="xml/ges-keyfile-formatter.xml"/> -->
+  <!-- </chapter> -->
+
+  <chapter id="ges-hierarchy">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+</book>
diff --git a/docs/libs/gst-rtsp-server-sections.txt b/docs/libs/gst-rtsp-server-sections.txt
new file mode 100644
index 0000000..a86beac
--- /dev/null
+++ b/docs/libs/gst-rtsp-server-sections.txt
@@ -0,0 +1,223 @@
+<SECTION>
+<FILE>rtsp-media-mapping</FILE>
+<TITLE>GstRTSPMediaMapping</TITLE>
+GstRTSPMediaMapping
+GstRTSPMediaMappingClass
+gst_rtsp_media_mapping_new
+gst_rtsp_media_mapping_find_factory
+gst_rtsp_media_mapping_add_factory
+gst_rtsp_media_mapping_remove_factory
+<SUBSECTION Standard>
+GST_RTSP_MEDIA_MAPPING_CLASS
+GST_RTSP_MEDIA_MAPPING_CAST
+GST_RTSP_MEDIA_MAPPING_CLASS_CAST
+GST_RTSP_MEDIA_MAPPING
+GST_IS_RTSP_MEDIA_MAPPING
+GST_TYPE_RTSP_MEDIA_MAPPING
+gst_rtsp_media_mapping_get_type
+GST_IS_RTSP_MEDIA_MAPPING_CLASS
+GST_RTSP_MEDIA_MAPPING_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-media-factory</FILE>
+<TITLE>GstRTSPMediaFactory</TITLE>
+GstRTSPMediaFactory
+GstRTSPMediaFactoryClass
+gst_rtsp_media_factory_new
+gst_rtsp_media_factory_set_launch
+gst_rtsp_media_factory_get_launch
+gst_rtsp_media_factory_set_shared
+gst_rtsp_media_factory_is_shared
+gst_rtsp_media_factory_set_eos_shutdown
+gst_rtsp_media_factory_is_eos_shutdown
+gst_rtsp_media_factory_construct
+gst_rtsp_media_factory_collect_streams
+<SUBSECTION Standard>
+GST_RTSP_MEDIA_FACTORY_CLASS
+GST_RTSP_MEDIA_FACTORY_CAST
+GST_RTSP_MEDIA_FACTORY_CLASS_CAST
+GST_RTSP_MEDIA_FACTORY
+GST_IS_RTSP_MEDIA_FACTORY
+GST_TYPE_RTSP_MEDIA_FACTORY
+gst_rtsp_media_factory_get_type
+GST_IS_RTSP_MEDIA_FACTORY_CLASS
+GST_RTSP_MEDIA_FACTORY_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-media</FILE>
+<TITLE>GstRTSPMedia</TITLE>
+GstRTSPMediaStream
+GstRTSPMedia
+GstRTSPMediaClass
+GstRTSPMediaTrans
+GstRTSPSendFunc
+GstRTSPKeepAliveFunc
+GstRTSPMediaStatus
+gst_rtsp_media_new
+gst_rtsp_media_set_shared
+gst_rtsp_media_is_shared
+gst_rtsp_media_set_reusable
+gst_rtsp_media_is_reusable
+gst_rtsp_media_set_protocols
+gst_rtsp_media_get_protocols
+gst_rtsp_media_set_eos_shutdown
+gst_rtsp_media_is_eos_shutdown
+gst_rtsp_media_prepare
+gst_rtsp_media_is_prepared
+gst_rtsp_media_unprepare
+gst_rtsp_media_n_streams
+gst_rtsp_media_get_stream
+gst_rtsp_media_seek
+gst_rtsp_media_stream_rtp
+gst_rtsp_media_stream_rtcp
+gst_rtsp_media_set_state
+gst_rtsp_media_remove_elements
+gst_rtsp_media_trans_cleanup
+<SUBSECTION Standard>
+GST_RTSP_MEDIA_CLASS
+GST_RTSP_MEDIA_CAST
+GST_RTSP_MEDIA_CLASS_CAST
+GST_RTSP_MEDIA
+GST_IS_RTSP_MEDIA
+GST_TYPE_RTSP_MEDIA
+gst_rtsp_media_get_type
+GST_IS_RTSP_MEDIA_CLASS
+GST_RTSP_MEDIA_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-server</FILE>
+<TITLE>GstRTSPServer</TITLE>
+GstRTSPServer
+GstRTSPServerClass
+gst_rtsp_server_new
+gst_rtsp_server_set_address
+gst_rtsp_server_get_address
+gst_rtsp_server_set_service
+gst_rtsp_server_get_service
+gst_rtsp_server_set_backlog
+gst_rtsp_server_get_backlog
+gst_rtsp_server_set_session_pool
+gst_rtsp_server_get_session_pool
+gst_rtsp_server_set_media_mapping
+gst_rtsp_server_get_media_mapping
+gst_rtsp_server_io_func
+gst_rtsp_server_get_io_channel
+gst_rtsp_server_create_watch
+gst_rtsp_server_attach
+<SUBSECTION Standard>
+GST_RTSP_SERVER_CLASS
+GST_RTSP_SERVER_CAST
+GST_RTSP_SERVER_CLASS_CAST
+GST_RTSP_SERVER
+GST_IS_RTSP_SERVER
+GST_TYPE_RTSP_SERVER
+gst_rtsp_server_get_type
+GST_IS_RTSP_SERVER_CLASS
+GST_RTSP_SERVER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-session-pool</FILE>
+<TITLE>GstRTSPSessionPool</TITLE>
+GstRTSPSessionPool
+GstRTSPSessionPoolClass
+GstRTSPSessionPoolFunc
+GstRTSPFilterResult
+GstRTSPSessionFilterFunc
+gst_rtsp_session_pool_new
+gst_rtsp_session_pool_set_max_sessions
+gst_rtsp_session_pool_get_max_sessions
+gst_rtsp_session_pool_get_n_sessions
+gst_rtsp_session_pool_create
+gst_rtsp_session_pool_find
+gst_rtsp_session_pool_remove
+gst_rtsp_session_pool_filter
+gst_rtsp_session_pool_cleanup
+gst_rtsp_session_pool_create_watch
+<SUBSECTION Standard>
+GST_RTSP_SESSION_POOL_CLASS
+GST_RTSP_SESSION_POOL_CAST
+GST_RTSP_SESSION_POOL_CLASS_CAST
+GST_RTSP_SESSION_POOL
+GST_IS_RTSP_SESSION_POOL
+GST_TYPE_RTSP_SESSION_POOL
+gst_rtsp_session_pool_get_type
+GST_IS_RTSP_SESSION_POOL_CLASS
+GST_RTSP_SESSION_POOL_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-session</FILE>
+<TITLE>GstRTSPSession</TITLE>
+GstRTSPSession
+GstRTSPSessionClass
+GstRTSPSessionStream
+GstRTSPSessionMedia
+gst_rtsp_session_new
+gst_rtsp_session_get_sessionid
+gst_rtsp_session_set_timeout
+gst_rtsp_session_get_timeout
+gst_rtsp_session_touch
+gst_rtsp_session_prevent_expire
+gst_rtsp_session_allow_expire
+gst_rtsp_session_next_timeout
+gst_rtsp_session_is_expired
+gst_rtsp_session_manage_media
+gst_rtsp_session_release_media
+gst_rtsp_session_get_media
+gst_rtsp_session_media_set_state
+gst_rtsp_session_media_get_stream
+gst_rtsp_session_media_alloc_channels
+gst_rtsp_session_stream_set_transport
+gst_rtsp_session_stream_set_callbacks
+gst_rtsp_session_stream_set_keepalive
+<SUBSECTION Standard>
+GST_RTSP_SESSION_CLASS
+GST_RTSP_SESSION_CAST
+GST_RTSP_SESSION_CLASS_CAST
+GST_RTSP_SESSION
+GST_IS_RTSP_SESSION
+GST_TYPE_RTSP_SESSION
+gst_rtsp_session_get_type
+GST_IS_RTSP_SESSION_CLASS
+GST_RTSP_SESSION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-client</FILE>
+<TITLE>GstRTSPClient</TITLE>
+GstRTSPClient
+GstRTSPClientClass
+gst_rtsp_client_new
+gst_rtsp_client_set_session_pool
+gst_rtsp_client_get_session_pool
+gst_rtsp_client_set_media_mapping
+gst_rtsp_client_get_media_mapping
+gst_rtsp_client_accept
+<SUBSECTION Standard>
+GST_RTSP_CLIENT_CLASS
+GST_RTSP_CLIENT_CAST
+GST_RTSP_CLIENT_CLASS_CAST
+GST_RTSP_CLIENT
+GST_IS_RTSP_CLIENT
+GST_TYPE_RTSP_CLIENT
+gst_rtsp_client_get_type
+GST_IS_RTSP_CLIENT_CLASS
+GST_RTSP_CLIENT_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-params</FILE>
+gst_rtsp_params_set
+gst_rtsp_params_get
+</SECTION>
+
+<SECTION>
+<FILE>rtsp-sdp</FILE>
+GstSDPInfo
+gst_rtsp_sdp_from_media
+</SECTION>
+
diff --git a/docs/libs/gst-rtsp-server.types b/docs/libs/gst-rtsp-server.types
new file mode 100644
index 0000000..e87c425
--- /dev/null
+++ b/docs/libs/gst-rtsp-server.types
@@ -0,0 +1,8 @@
+#include <gst/gst.h>
+gst_rtsp_media_mapping_get_type
+gst_rtsp_media_factory_get_type
+gst_rtsp_media_get_type
+gst_rtsp_server_get_type
+gst_rtsp_session_pool_get_type
+gst_rtsp_session_get_type
+gst_rtsp_client_get_type
diff --git a/docs/version.entities.in b/docs/version.entities.in
new file mode 100644
index 0000000..34dc4bc
--- /dev/null
+++ b/docs/version.entities.in
@@ -0,0 +1 @@
+<!ENTITY GST_MAJORMINOR "@GST_MAJORMINOR@">