gtk: first stab at gtk-doc documentation

6 files changed, 288 insertions, 0 deletions

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..2e54566
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,22 @@
+/*.bak
+/*.lo
+/*.o
+/*.orig
+/*.rej
+/*.tab.c
+/*~
+/.*.sw[nop]
+/.deps
+/.gitignore
+/.libs
+/GPATH
+/GRTAGS
+/GSYMS
+/GTAGS
+/ID
+/Makefile
+/Makefile.in
+/TAGS
+/_libs
+/so_locations
+/tags
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..034926c
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,3 @@
+SUBDIRS = reference
+
+-include $(top_srcdir)/git.mk
diff --git a/doc/reference/.gitignore b/doc/reference/.gitignore
new file mode 100644
index 0000000..34eb965
--- /dev/null
+++ b/doc/reference/.gitignore
@@ -0,0 +1,43 @@
+/*.bak
+/*.lo
+/*.o
+/*.orig
+/*.rej
+/*.tab.c
+/*~
+/.*.sw[nop]
+/.deps
+/.gitignore
+/.libs
+/GPATH
+/GRTAGS
+/GSYMS
+/GTAGS
+/ID
+/Makefile
+/Makefile.in
+/TAGS
+/_libs
+/html
+/html-build.stamp
+/html.stamp
+/pdf-build.stamp
+/pdf.stamp
+/scan-build.stamp
+/sgml-build.stamp
+/sgml.stamp
+/so_locations
+/spice-gtk-decl-list.txt
+/spice-gtk-decl.txt
+/spice-gtk-undeclared.txt
+/spice-gtk-undocumented.txt
+/spice-gtk-unused.txt
+/spice-gtk.args
+/spice-gtk.hierarchy
+/spice-gtk.interfaces
+/spice-gtk.prerequisites
+/spice-gtk.signals
+/tags
+/tmpl/*.bak
+/tmpl/spice-gtk-unused.sgml
+/xml
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
new file mode 100644
index 0000000..b01b6e7
--- /dev/null
+++ b/doc/reference/Makefile.am
@@ -0,0 +1,120 @@
+## 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=spice-gtk
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# Directories containing the source code, relative to $(srcdir).
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
+DOC_SOURCE_DIR=../../gtk
+
+# 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=--xml-mode --output-format=xml
+MKDB_OPTIONS=--xml-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-mkhtml
+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=
+
+# 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=$(top_srcdir)/gtk/*.h
+CFILE_GLOB=$(top_srcdir)/gtk/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= \
+	spice-display-mjpeg.h			\
+	channel-display-priv.h			\
+	spice-channel-priv.h			\
+	continuation.h				\
+	coroutine.h				\
+	decode.h				\
+	gio-coroutine.h				\
+	spice-channel-cache.h			\
+	spice-marshal.h				\
+	spice-pulse.h				\
+	spice-session-priv.h			\
+	spice-types.h				\
+	tcp.h					\
+	vncdisplaykeymap.h			\
+	vncgrabsequence.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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) -I$(top_srcdir)/gtk -I$(top_builddir)/gtk $(SPICE_GLIB_CFLAGS) $(SPICE_GTK_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/gtk/libspice-client-glib.la $(top_builddir)/gtk/libspice-client-gtk.la
+
+# 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 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = cd $(srcdir) && \
+  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+#TESTS = $(GTKDOC_CHECK)
+endif
+
+-include $(top_srcdir)/git.mk
diff --git a/doc/reference/spice-gtk-docs.xml b/doc/reference/spice-gtk-docs.xml
new file mode 100644
index 0000000..52903c4
--- /dev/null
+++ b/doc/reference/spice-gtk-docs.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Spice-GTK Reference Manual</title>
+<!--
+    <releaseinfo>
+      for spice-gtk [VERSION].
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/spice-gtk/index.html">http://[SERVER]/spice-gtk/</ulink>.
+    </releaseinfo>
+-->
+  </bookinfo>
+
+  <part id="api-reference">
+    <title>API Reference</title>
+    <chapter>
+      <title>Object Hierarchy</title>
+      <xi:include href="xml/tree_index.sgml" />
+    </chapter>
+
+    <chapter>
+      <title>Session and Channels Objects, from spice-client-glib</title>
+      <xi:include href="xml/spice-session.xml"/>
+      <xi:include href="xml/spice-channel.xml"/>
+      <xi:include href="xml/channel-cursor.xml"/>
+      <xi:include href="xml/channel-display.xml"/>
+      <xi:include href="xml/channel-inputs.xml"/>
+      <xi:include href="xml/channel-main.xml"/>
+      <xi:include href="xml/channel-playback.xml"/>
+      <xi:include href="xml/channel-record.xml"/>
+      <xi:include href="xml/spice-channel-enums.xml"/>
+    </chapter>
+
+    <chapter id="application-support">
+      <title>Application support, from spice-client-glib</title>
+      <xi:include href="xml/spice-audio.xml"/>
+      <xi:include href="xml/spice-cmdline.xml"/>
+      <xi:include href="xml/spice-util.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Display GTK Widget, from spice-client-gtk</title>
+      <xi:include href="xml/spice-widget.xml"/>
+      <xi:include href="xml/spice-widget-enums.xml"/>
+    </chapter>
+  </part>
+
+  <chapter id="object-tree">
+    <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>
+  <!--
+      <index role="2.26">
+      <title>Index of new symbols in 2.26</title>
+      <xi:include href="xml/api-index-2.26.xml"><xi:fallback/></xi:include>
+      </index>
+  -->
+  <index id="api-index-deprecated" role="deprecated">
+    <title>Index of deprecated symbols</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/doc/reference/spice-gtk.types b/doc/reference/spice-gtk.types
new file mode 100644
index 0000000..cc481b5
--- /dev/null
+++ b/doc/reference/spice-gtk.types
@@ -0,0 +1,27 @@
+#include "spice-audio.h"
+#include "spice-client.h"
+#include "spice-types.h"
+#include "spice-session.h"
+#include "spice-channel.h"
+#include "spice-channel-enums.h"
+#include "spice-util.h"
+#include "channel-main.h"
+#include "channel-display.h"
+#include "channel-cursor.h"
+#include "channel-inputs.h"
+#include "channel-playback.h"
+#include "channel-record.h"
+#include "spice-widget.h"
+
+spice_audio_get_type
+spice_channel_get_type
+spice_channel_event_get_type
+spice_cursor_channel_get_type
+spice_display_channel_get_type
+spice_inputs_channel_get_type
+spice_inputs_lock_get_type
+spice_main_channel_get_type
+spice_playback_channel_get_type
+spice_record_channel_get_type
+spice_session_get_type
+spice_display_get_type