add complete documentation

git-svn-id: file:///home/lennart/svn/public/libcanberra/trunk@57 01b60673-d06a-42c0-afdd-89cb8e0f78ac

4 files changed, 183 insertions, 0 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..963a93d
--- /dev/null
+++ b/doc/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=libcanberra
+
+# 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=../src
+
+# 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=
+CFILE_GLOB=
+
+# 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)
+
diff --git a/doc/libcanberra-docs.sgml b/doc/libcanberra-docs.sgml
new file mode 100644
index 0000000..6505314
--- /dev/null
+++ b/doc/libcanberra-docs.sgml
@@ -0,0 +1,19 @@
+<?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>libcanberra Reference Manual</title>
+    <releaseinfo>
+      for libcanberra 0.1
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://0pointer.de/projects/libcanberra/doc/index.html">http://0pointer.de/projects/libcanberra/doc/index.html</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>libcanberra</title>
+    <xi:include href="xml/canberra.xml"/>
+    <xi:include href="xml/canberra-gtk.xml"/>
+  </chapter>
+</book>
diff --git a/doc/libcanberra-sections.txt b/doc/libcanberra-sections.txt
new file mode 100644
index 0000000..326faa1
--- /dev/null
+++ b/doc/libcanberra-sections.txt
@@ -0,0 +1,77 @@
+<SECTION>
+<FILE>canberra-gtk</FILE>
+ca_gtk_context_get
+ca_gtk_proplist_set_for_widget
+ca_gtk_play_for_widget
+ca_gtk_proplist_set_for_event
+ca_gtk_play_for_event
+ca_gtk_widget_disable_sounds
+</SECTION>
+
+<SECTION>
+<FILE>canberra</FILE>
+CA_PROP_MEDIA_NAME
+CA_PROP_MEDIA_TITLE
+CA_PROP_MEDIA_ARTIST
+CA_PROP_MEDIA_LANGUAGE
+CA_PROP_MEDIA_FILENAME
+CA_PROP_MEDIA_ICON
+CA_PROP_MEDIA_ICON_NAME
+CA_PROP_MEDIA_ROLE
+CA_PROP_EVENT_ID
+CA_PROP_EVENT_DESCRIPTION
+CA_PROP_EVENT_MOUSE_X
+CA_PROP_EVENT_MOUSE_Y
+CA_PROP_EVENT_MOUSE_HPOS
+CA_PROP_EVENT_MOUSE_VPOS
+CA_PROP_EVENT_MOUSE_BUTTON
+CA_PROP_WINDOW_NAME
+CA_PROP_WINDOW_ID
+CA_PROP_WINDOW_ICON
+CA_PROP_WINDOW_ICON_NAME
+CA_PROP_WINDOW_X11_DISPLAY
+CA_PROP_WINDOW_X11_SCREEN
+CA_PROP_WINDOW_X11_MONITOR
+CA_PROP_WINDOW_X11_XID
+CA_PROP_APPLICATION_NAME
+CA_PROP_APPLICATION_ID
+CA_PROP_APPLICATION_VERSION
+CA_PROP_APPLICATION_ICON
+CA_PROP_APPLICATION_ICON_NAME
+CA_PROP_APPLICATION_LANGUAGE
+CA_PROP_APPLICATION_PROCESS_ID
+CA_PROP_APPLICATION_PROCESS_BINARY
+CA_PROP_APPLICATION_PROCESS_USER
+CA_PROP_APPLICATION_PROCESS_HOST
+CA_PROP_CANBERRA_CACHE_CONTROL
+CA_PROP_CANBERRA_VOLUME
+CA_PROP_CANBERRA_XDG_THEME_NAME
+CA_PROP_CANBERRA_XDG_THEME_OUTPUT_PROFILE
+
+<SUBSECTION>
+ca_context
+ca_finish_callback_t
+ca_context_create
+ca_context_destroy
+ca_context_open
+ca_context_set_driver
+ca_context_change_device
+ca_context_change_props
+ca_context_change_props_full
+ca_context_play
+ca_context_play_full
+ca_context_cancel
+ca_context_cache
+ca_context_cache_full
+
+<SUBSECTION>
+ca_strerror
+
+<SUBSECTION>
+ca_proplist
+ca_proplist_create
+ca_proplist_destroy
+ca_proplist_sets
+ca_proplist_setf
+ca_proplist_set
+</SECTION>
diff --git a/doc/libcanberra.types b/doc/libcanberra.types
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/libcanberra.types