doc fixes

13 files changed, 318 insertions, 40 deletions

diff --git a/configure.ac b/configure.ac
index ef119f4..54e3c05 100644
--- a/configure.ac
+++ b/configure.ac
@@ -144,6 +144,14 @@ if test "x$cross_compiling" = "xyes" ; then
 fi
 GTK_DOC_CHECK([1.0])
 
+dnl Check for documentation xrefs
+GLIB_PREFIX="`$PKG_CONFIG --variable=prefix glib-2.0`"
+AC_SUBST(GLIB_PREFIX)
+GST_PREFIX="`$PKG_CONFIG --variable=prefix gstreamer-1.0`"
+AC_SUBST(GST_PREFIX)
+SOUP_PREFIX="`$PKG_CONFIG --variable=prefix libsoup-2.4`"
+AC_SUBST(SOUP_PREFIX)
+
 
 ########################
 # GStreamer stuff
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 76e73e8..f7c5ee0 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -44,7 +44,7 @@ MKHTML_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=
+FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html --extra-dir=$(GST_PREFIX)/share/gtk-doc/html --extra-dir=$(SOUP_PREFIX)/share/gtk-doc/html
 
 # Used for dependencies. The docs will be rebuilt if any of these change.
 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
@@ -58,7 +58,7 @@ EXTRA_HFILES=
 
 # Header files to ignore when scanning. Use base file name, no paths
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=
+IGNORE_HFILES=gss-content.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/doc/building.xml b/doc/building.xml
new file mode 100644
index 0000000..a7f8fc5
--- /dev/null
+++ b/doc/building.xml
@@ -0,0 +1,100 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<refentry id="gst-building" revision="25 mar 2009">
+<refmeta>
+<refentrytitle>Building GStreamer and GStreamer Applications</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GStreamer Core</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Building GStreamer and GStreamer Applications</refname>
+<refpurpose>
+How to build the GStreamer framework and applications using it.
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>Building GStreamer on UNIX</title>
+
+  <!-- this has been borrowed from the glib docs -->
+  <para>
+    On UNIX, GStreamer uses the standard GNU build system,
+    using <application>autoconf</application> for package
+    configuration and resolving portability issues,
+    <application>automake</application> for building makefiles
+    that comply with the GNU Coding Standards, and
+    <application>libtool</application> for building shared
+    libraries on multiple platforms.  The normal sequence for
+    compiling and installing the GStreamer library is thus:
+
+    <literallayout>
+      <userinput>./configure</userinput>
+      <userinput>make</userinput>
+      <userinput>make install</userinput>
+    </literallayout>
+  </para>
+
+  <para>
+    The standard options provided by <application>GNU
+    autoconf</application> may be passed to the
+    <command>configure</command> script.  Please see the
+    <application>autoconf</application> documentation or run
+    <command>./configure --help</command> for information about
+    the standard options.
+  </para>
+
+  <para>
+    In addition there are several options to activate or deactivate features.
+    E.g. passing <option>--disable-gst-debug</option> to <command>configure</command>
+    will turn the debugging subsystem into a non-functional stub and remove all
+    macro based invocations from within the library (and anything compiled
+    against the library afterwards.)
+  </para>
+  <para>
+    If library size matters and one builds in a controlled environment, it is
+    also possible to totally remove subsystem code. This is intentionally not
+    offered as a configure option as it causes an ABI break. Code built against
+    a version of GStreamer without these modifications needs to be recompiled.
+
+    <literallayout>
+      <userinput>make CFLAGS="-DGST_REMOVE_DEPRECATED -DGST_REMOVE_DISABLED"</userinput>
+    </literallayout>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          <symbol>GST_REMOVE_DEPRECATED</symbol> - Omit deprecated functions
+          from the library.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <symbol>GST_REMOVE_DISABLED</symbol> - Omit stubs for disabled
+          subsystems from the library.
+        </para>
+      </listitem>
+    </itemizedlist>
+  </para>
+
+</refsect1>
+
+<refsect1>
+<title>Building GStreamer Applications</title>
+
+<para>
+Applications and libraries can use <command>pkg-config</command> to get all the
+needed compiler and linker flags to build against GStreamer. Please note that
+GStreamer is split into several libraries itself.
+<command>pkg-config --list-all | grep gstreamer</command> will list the
+available libraries.
+</para>
+
+</refsect1>
+
+</refentry>
diff --git a/doc/getting-started.xml b/doc/getting-started.xml
new file mode 100644
index 0000000..7e73a23
--- /dev/null
+++ b/doc/getting-started.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<refentry id="gss-getting-started" revision="12 jan 2014">
+<refmeta>
+<refentrytitle>Getting Started</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GStreamer Streaming Server</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Getting Started</refname>
+<refpurpose>
+Getting started with GStreamer Streaming Server.
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>Getting Started</title>
+
+  <para>
+    Start here.
+  </para>
+
+</refsect1>
+
+</refentry>
diff --git a/doc/gss-http-server.xml b/doc/gss-http-server.xml
new file mode 100644
index 0000000..ae9c2db
--- /dev/null
+++ b/doc/gss-http-server.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<refentry id="gss-http-server" revision="12 jan 2014">
+<refmeta>
+<refentrytitle>GSS HTTP Server</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GSS HTTP Server</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>GSS HTTP Server</refname>
+<refpurpose>
+About the HTTP Server.
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>GSS HTTP Server</title>
+
+  <para>
+    Stuff.
+  </para>
+
+</refsect1>
+
+</refentry>
diff --git a/doc/gst-helper.h b/doc/gst-helper.h
new file mode 100644
index 0000000..9f4950e
--- /dev/null
+++ b/doc/gst-helper.h
@@ -0,0 +1 @@
+#include <gst/gst.h>
diff --git a/doc/gst-streaming-server-docs.sgml b/doc/gst-streaming-server-docs.sgml
index 59d5fe6..e5e82fb 100644
--- a/doc/gst-streaming-server-docs.sgml
+++ b/doc/gst-streaming-server-docs.sgml
@@ -8,16 +8,25 @@
 ]>
 <book id="index">
   <bookinfo>
-    <title>gst-streaming-server Reference Manual</title>
+    <title>GStreamer Streaming Server Reference Manual</title>
     <releaseinfo>
-      for gst-streaming-server &GSS_VERSION;.
+      This manual is for gst-streaming-server-&GSS_VERSION;.
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://gstreamer.net/gst-streaming-server/index.html">http://gstreamer.net/gst-streaming-server/</ulink>.
     </releaseinfo>
   </bookinfo>
 
   <chapter>
-    <title>GSS Standalone Server</title>
+    <title>Getting Started</title>
+    <xi:include href="getting-started.xml"/>
+  </chapter>
+  <chapter>
+    <title>Installation</title>
+    <xi:include href="installation.xml"/>
+  </chapter>
+  <chapter>
+    <title>GSS HTTP Server</title>
+    <xi:include href="gss-http-server.xml"/>
   </chapter>
   <chapter>
     <title>GSS Library Reference</title>
@@ -46,7 +55,7 @@
     <xi:include href="xml/gss-soup.xml"/>
     <xi:include href="xml/gss-stream.xml"/>
     <xi:include href="xml/gss-transaction.xml"/>
-    <xi:include href="xml/gss-types.xml"/>
+    <!-- <xi:include href="xml/gss-types.xml"/> -->
     <xi:include href="xml/gss-user.xml"/>
     <xi:include href="xml/gss-utils.xml"/>
     <xi:include href="xml/gss-vod.xml"/>
@@ -66,5 +75,5 @@
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
 
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  <!-- <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> -->
 </book>
diff --git a/doc/gst-streaming-server-overrides.txt b/doc/gst-streaming-server-overrides.txt
index e69de29..d1aab3e 100644
--- a/doc/gst-streaming-server-overrides.txt
+++ b/doc/gst-streaming-server-overrides.txt
@@ -0,0 +1,12 @@
+gss_data_bootstrap_css_len
+gss_data_bootstrap_js_len
+gss_data_bootstrap_responsive_css_len
+gss_data_dash_min_js_len
+gss_data_footer_entropywave_png_len
+gss_data_glyphicons_halflings_png_len
+gss_data_glyphicons_halflings_white_png_len
+gss_data_include_js_len
+gss_data_jquery_js_len
+gss_data_no_snapshot_jpg_len
+gss_data_offline_jpg_len
+gss_data_sign_in_blue_png_len
diff --git a/doc/gst-streaming-server-sections.txt b/doc/gst-streaming-server-sections.txt
index 3be6cdd..d6b2b69 100644
--- a/doc/gst-streaming-server-sections.txt
+++ b/doc/gst-streaming-server-sections.txt
@@ -23,7 +23,6 @@ gss_config_attach
 gss_config_create_object
 gss_config_create_object_2
 gss_config_get_post_hash
-gss_config_get_type
 gss_config_handle_post
 gss_config_handle_post_hash
 gss_config_load_config_file
@@ -233,7 +232,6 @@ gss_json_gobject_to_data
 <SECTION>
 <FILE>gss-manager</FILE>
 gss_manager_create_pipeline
-gss_manager_get_type
 gss_manager_new
 gss_manager_set_location
 gss_manager_start
@@ -261,7 +259,6 @@ gss_metrics_remove_client
 
 <SECTION>
 <FILE>gss-module</FILE>
-gss_module_get_type
 gss_module_set_admin_resource
 <SUBSECTION Standard>
 GssModule
@@ -281,7 +278,6 @@ GSS_OBJECT_NAME
 GSS_OBJECT_SAFE_TITLE
 GSS_OBJECT_SERVER
 GSS_OBJECT_TITLE
-gss_object_get_type
 gss_object_param_is_secure
 gss_object_set_automatic_name
 gss_object_set_name
@@ -376,7 +372,6 @@ gss_program_get_type
 
 <SECTION>
 <FILE>gss-pull</FILE>
-gss_pull_get_type
 gss_pull_new
 <SUBSECTION Standard>
 GssPull
@@ -392,7 +387,6 @@ gss_pull_get_type
 
 <SECTION>
 <FILE>gss-push</FILE>
-gss_push_get_type
 gss_push_new
 GssPushMethod
 <SUBSECTION Standard>
@@ -433,6 +427,7 @@ gss_server_rtsp_init
 <SECTION>
 <FILE>gss-server</FILE>
 <TITLE>GssServer</TITLE>
+GssFooterHtml
 GssServer
 GssServerClass
 gss_server_add_admin_callbacks
@@ -552,6 +547,8 @@ gss_stream_get_type
 
 <SECTION>
 <FILE>gss-transaction</FILE>
+GssTransactionCallback
+GssTransactionFunc
 GssTransaction
 gss_transaction_delay
 gss_transaction_dump
@@ -597,7 +594,6 @@ GSS_IS_USER_CLASS
 GSS_USER
 GSS_USER_CLASS
 GSS_TYPE_USER
-gss_user_get_type
 </SECTION>
 
 <SECTION>
@@ -633,7 +629,6 @@ GSS_VOD_GET_CLASS
 GSS_VOD
 GSS_VOD_CLASS
 GSS_TYPE_VOD
-gss_vod_get_type
 </SECTION>
 
 <SECTION>
@@ -651,19 +646,3 @@ GSS_TYPE_WEBSOCKET
 gss_websocket_get_type
 </SECTION>
 
-<SECTION>
-<FILE>junk</FILE>
-gss_data_bootstrap_css_len
-gss_data_bootstrap_js_len
-gss_data_bootstrap_responsive_css_len
-gss_data_dash_min_js_len
-gss_data_footer_entropywave_png_len
-gss_data_glyphicons_halflings_png_len
-gss_data_glyphicons_halflings_white_png_len
-gss_data_include_js_len
-gss_data_jquery_js_len
-gss_data_no_snapshot_jpg_len
-gss_data_offline_jpg_len
-gss_data_sign_in_blue_png_len
-</SECTION>
-
diff --git a/doc/installation.xml b/doc/installation.xml
new file mode 100644
index 0000000..a0cfb5d
--- /dev/null
+++ b/doc/installation.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<refentry id="gss-installation" revision="04 jan 2014">
+<refmeta>
+<refentrytitle>Building</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>GStreamer Streaming Server</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Building GStreamer Streaming Server</refname>
+<refpurpose>
+How to build the GStreamer Streaming Server.
+</refpurpose>
+</refnamediv>
+
+<refsect1>
+<title>Building GStreamer Streaming Server on UNIX</title>
+
+  <!-- this has been borrowed from the glib docs -->
+  <para>
+    On UNIX, GStreamer Streaming Server uses the standard GNU build system,
+    using <application>autoconf</application> for package
+    configuration and resolving portability issues,
+    <application>automake</application> for building makefiles
+    that comply with the GNU Coding Standards, and
+    <application>libtool</application> for building shared
+    libraries on multiple platforms.  The normal sequence for
+    compiling and installing the GStreamer library is thus:
+
+    <literallayout>
+      <userinput>./configure</userinput>
+      <userinput>make</userinput>
+      <userinput>make install</userinput>
+    </literallayout>
+  </para>
+
+  <para>
+    The standard options provided by <application>GNU
+    autoconf</application> may be passed to the
+    <command>configure</command> script.  Please see the
+    <application>autoconf</application> documentation or run
+    <command>./configure --help</command> for information about
+    the standard options.
+  </para>
+
+<!--
+  <para>
+    In addition there are several options to activate or deactivate features.
+    E.g. passing <option>- -disable-gst-debug</option> to <command>configure</command>
+    will turn the debugging subsystem into a non-functional stub and remove all
+    macro based invocations from within the library (and anything compiled
+    against the library afterwards.)
+  </para>
+-->
+<!--
+  <para>
+    If library size matters and one builds in a controlled environment, it is
+    also possible to totally remove subsystem code. This is intentionally not
+    offered as a configure option as it causes an ABI break. Code built against
+    a version of GStreamer without these modifications needs to be recompiled.
+
+    <literallayout>
+      <userinput>make CFLAGS="-DGST_REMOVE_DEPRECATED -DGST_REMOVE_DISABLED"</userinput>
+    </literallayout>
+
+    <itemizedlist>
+      <listitem>
+        <para>
+          <symbol>GST_REMOVE_DEPRECATED</symbol> - Omit deprecated functions
+          from the library.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <symbol>GST_REMOVE_DISABLED</symbol> - Omit stubs for disabled
+          subsystems from the library.
+        </para>
+      </listitem>
+    </itemizedlist>
+  </para>
+-->
+
+</refsect1>
+
+<refsect1>
+<title>Installing on Ubuntu</title>
+
+<para>
+  The GSS project maintainer occasionally uploads snapshots to the
+  GStreamer Streaming Server PPA, hosted on Launchpad.  Launchpad
+  automatically builds the package for precise on amd64 and i386,
+  which can be installed on precise or any later Ubuntu system.
+</para>
+
+<para>
+  https://launchpad.net/~dschleef/+archive/matterhorn-ppa/
+</para>
+
+</refsect1>
+
+</refentry>
diff --git a/gst-streaming-server/gss-resource.h b/gst-streaming-server/gss-resource.h
index c214aa3..9b8d877 100644
--- a/gst-streaming-server/gss-resource.h
+++ b/gst-streaming-server/gss-resource.h
@@ -48,9 +48,9 @@ struct _GssResource {
 
   GssResourceFlags flags;
 
-  GssTransactionCallback *get_callback;
-  GssTransactionCallback *put_callback;
-  GssTransactionCallback *post_callback;
+  GssTransactionCallback get_callback;
+  GssTransactionCallback put_callback;
+  GssTransactionCallback post_callback;
 
   GDestroyNotify destroy;
 
diff --git a/gst-streaming-server/gss-server.h b/gst-streaming-server/gss-server.h
index d317d4b..6578c20 100644
--- a/gst-streaming-server/gss-server.h
+++ b/gst-streaming-server/gss-server.h
@@ -49,7 +49,7 @@ G_BEGIN_DECLS
 #define GSS_IS_SERVER_CLASS(obj) \
   (G_TYPE_CHECK_CLASS_TYPE((klass),GSS_TYPE_SERVER))
 
-typedef void (GssFooterHtml) (GssServer *server, GString *s, void *priv);
+typedef void (*GssFooterHtml) (GssServer *server, GString *s, void *priv);
 
 struct _GssServer
 {
@@ -96,7 +96,7 @@ struct _GssServer
 
   //time_t config_timestamp;
 
-  GssFooterHtml *footer_html;
+  GssFooterHtml footer_html;
   void *footer_html_priv;
 
   GList *modules;
diff --git a/gst-streaming-server/gss-transaction.h b/gst-streaming-server/gss-transaction.h
index 8dc2358..28a704c 100644
--- a/gst-streaming-server/gss-transaction.h
+++ b/gst-streaming-server/gss-transaction.h
@@ -28,8 +28,8 @@
 
 G_BEGIN_DECLS
 
-typedef void (GssTransactionCallback)(GssTransaction *transaction);
-typedef void (GssTransactionFunc)(GssTransaction *transaction,
+typedef void (*GssTransactionCallback)(GssTransaction *transaction);
+typedef void (*GssTransactionFunc)(GssTransaction *transaction,
     gpointer priv);
 
 struct _GssTransaction {
@@ -50,8 +50,8 @@ struct _GssTransaction {
   gint64 total_time;
   gsize start, end;
 
-  GssTransactionFunc *process;
-  GssTransactionFunc *finish;
+  GssTransactionFunc process;
+  GssTransactionFunc finish;
   gpointer priv;
 };