diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 1 | ||||
| -rw-r--r-- | docs/reference/Makefile.am | 109 | ||||
| -rw-r--r-- | docs/reference/libmatemixer-docs.xml | 32 | ||||
| -rw-r--r-- | docs/reference/libmatemixer-overrides.txt | 0 | ||||
| -rw-r--r-- | docs/reference/libmatemixer-sections.txt | 187 | ||||
| -rw-r--r-- | docs/reference/libmatemixer.types | 6 | ||||
| -rw-r--r-- | docs/reference/version.xml.in | 1 |
7 files changed, 336 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 9b582ee..034926c 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,2 +1,3 @@ +SUBDIRS = reference -include $(top_srcdir)/git.mk diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..d7fe572 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,109 @@ +## 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=libmatemixer + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + +# The top-level XML file (SGML in the past). You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# Directories containing the source code. +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk +DOC_SOURCE_DIR=$(top_srcdir)/libmatemixer + +# 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-sections --rebuild-types + +# 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)/libmatemixer/*.h +CFILE_GLOB=$(top_srcdir)/libmatemixer/*.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 or dirs to ignore when scanning. Use base file/dir names +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code +IGNORE_HFILES= \ + matemixer-backend.h \ + matemixer-backend-module.h \ + matemixer-enum-types.h \ + matemixer-private.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=version.xml + +# 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) \ + $(GLIB_CFLAGS) + +GTKDOC_LIBS= \ + $(top_builddir)/libmatemixer/libmatemixer.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 += version.xml.in + +# 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 = \ + 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/docs/reference/libmatemixer-docs.xml b/docs/reference/libmatemixer-docs.xml new file mode 100644 index 0000000..9a073a4 --- /dev/null +++ b/docs/reference/libmatemixer-docs.xml @@ -0,0 +1,32 @@ +<?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'"> + <!ENTITY version SYSTEM "version.xml"> +]> +<book id="index"> + <bookinfo> + <title>libmatemixer Reference Manual</title> + <releaseinfo> + for libmatemixer &version;. + </releaseinfo> + </bookinfo> + + <chapter> + <title>API Reference</title> + <xi:include href="xml/matemixer.xml"/> + <xi:include href="xml/matemixer-enums.xml"/> + <xi:include href="xml/matemixer-version.xml"/> + <xi:include href="xml/matemixer-client-stream.xml"/> + <xi:include href="xml/matemixer-control.xml"/> + <xi:include href="xml/matemixer-device.xml"/> + <xi:include href="xml/matemixer-port.xml"/> + <xi:include href="xml/matemixer-profile.xml"/> + <xi:include href="xml/matemixer-stream.xml"/> + </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/reference/libmatemixer-overrides.txt b/docs/reference/libmatemixer-overrides.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/reference/libmatemixer-overrides.txt diff --git a/docs/reference/libmatemixer-sections.txt b/docs/reference/libmatemixer-sections.txt new file mode 100644 index 0000000..e109f09 --- /dev/null +++ b/docs/reference/libmatemixer-sections.txt @@ -0,0 +1,187 @@ +<SECTION> +<FILE>matemixer</FILE> +mate_mixer_init +mate_mixer_deinit +</SECTION> + +<SECTION> +<FILE>matemixer-client-stream</FILE> +<TITLE>MateMixerClientStream</TITLE> +MateMixerClientStreamInterface +mate_mixer_client_stream_get_parent +mate_mixer_client_stream_set_parent +mate_mixer_client_stream_remove +MateMixerClientStream +<SUBSECTION Standard> +MATE_MIXER_CLIENT_STREAM +MATE_MIXER_CLIENT_STREAM_GET_INTERFACE +MATE_MIXER_IS_CLIENT_STREAM +MATE_MIXER_TYPE_CLIENT_STREAM +mate_mixer_client_stream_get_type +</SECTION> + +<SECTION> +<FILE>matemixer-control</FILE> +<TITLE>MateMixerControl</TITLE> +MateMixerControl +MateMixerControlClass +mate_mixer_control_new +mate_mixer_control_set_backend_type +mate_mixer_control_set_app_name +mate_mixer_control_set_app_id +mate_mixer_control_set_app_version +mate_mixer_control_set_app_icon +mate_mixer_control_set_server_address +mate_mixer_control_open +mate_mixer_control_get_state +mate_mixer_control_get_device +mate_mixer_control_get_stream +mate_mixer_control_list_devices +mate_mixer_control_list_streams +mate_mixer_control_get_default_input_stream +mate_mixer_control_set_default_input_stream +mate_mixer_control_get_default_output_stream +mate_mixer_control_set_default_output_stream +mate_mixer_control_get_backend_name +mate_mixer_control_get_backend_type +MateMixerControlPrivate +<SUBSECTION Standard> +MATE_MIXER_CONTROL +MATE_MIXER_CONTROL_CLASS +MATE_MIXER_CONTROL_GET_CLASS +MATE_MIXER_IS_CONTROL +MATE_MIXER_IS_CONTROL_CLASS +MATE_MIXER_TYPE_CONTROL +mate_mixer_control_get_type +</SECTION> + +<SECTION> +<FILE>matemixer-device</FILE> +<TITLE>MateMixerDevice</TITLE> +MateMixerDeviceInterface +mate_mixer_device_get_name +mate_mixer_device_get_description +mate_mixer_device_get_icon +mate_mixer_device_list_streams +mate_mixer_device_list_ports +mate_mixer_device_list_profiles +mate_mixer_device_get_active_profile +mate_mixer_device_set_active_profile +MateMixerDevice +<SUBSECTION Standard> +MATE_MIXER_DEVICE +MATE_MIXER_DEVICE_GET_INTERFACE +MATE_MIXER_IS_DEVICE +MATE_MIXER_TYPE_DEVICE +mate_mixer_device_get_type +</SECTION> + +<SECTION> +<FILE>matemixer-enums</FILE> +MateMixerState +MateMixerBackendType +MateMixerPortStatus +MateMixerStreamFlags +MateMixerStreamStatus +MateMixerChannelPosition +</SECTION> + +<SECTION> +<FILE>matemixer-port</FILE> +<TITLE>MateMixerPort</TITLE> +MateMixerPort +MateMixerPortClass +mate_mixer_port_new +mate_mixer_port_get_name +mate_mixer_port_get_description +mate_mixer_port_get_icon +mate_mixer_port_get_priority +mate_mixer_port_get_status +MateMixerPortPrivate +<SUBSECTION Standard> +MATE_MIXER_IS_PORT +MATE_MIXER_IS_PORT_CLASS +MATE_MIXER_PORT +MATE_MIXER_PORT_CLASS +MATE_MIXER_PORT_GET_CLASS +MATE_MIXER_TYPE_PORT +mate_mixer_port_get_type +</SECTION> + +<SECTION> +<FILE>matemixer-profile</FILE> +<TITLE>MateMixerProfile</TITLE> +MateMixerProfile +MateMixerProfileClass +mate_mixer_profile_new +mate_mixer_profile_get_name +mate_mixer_profile_get_description +mate_mixer_profile_get_priority +MateMixerProfilePrivate +<SUBSECTION Standard> +MATE_MIXER_IS_PROFILE +MATE_MIXER_IS_PROFILE_CLASS +MATE_MIXER_PROFILE +MATE_MIXER_PROFILE_CLASS +MATE_MIXER_PROFILE_GET_CLASS +MATE_MIXER_TYPE_PROFILE +mate_mixer_profile_get_type +</SECTION> + +<SECTION> +<FILE>matemixer-stream</FILE> +<TITLE>MateMixerStream</TITLE> +MateMixerStreamInterface +mate_mixer_stream_get_name +mate_mixer_stream_get_description +mate_mixer_stream_get_icon +mate_mixer_stream_get_device +mate_mixer_stream_get_flags +mate_mixer_stream_get_status +mate_mixer_stream_get_mute +mate_mixer_stream_set_mute +mate_mixer_stream_get_num_channels +mate_mixer_stream_get_volume +mate_mixer_stream_set_volume +mate_mixer_stream_get_volume_db +mate_mixer_stream_set_volume_db +mate_mixer_stream_get_channel_position +mate_mixer_stream_get_channel_volume +mate_mixer_stream_set_channel_volume +mate_mixer_stream_get_channel_volume_db +mate_mixer_stream_set_channel_volume_db +mate_mixer_stream_has_position +mate_mixer_stream_get_position_volume +mate_mixer_stream_set_position_volume +mate_mixer_stream_get_position_volume_db +mate_mixer_stream_set_position_volume_db +mate_mixer_stream_get_balance +mate_mixer_stream_set_balance +mate_mixer_stream_get_fade +mate_mixer_stream_set_fade +mate_mixer_stream_suspend +mate_mixer_stream_resume +mate_mixer_stream_list_ports +mate_mixer_stream_get_active_port +mate_mixer_stream_set_active_port +mate_mixer_stream_get_min_volume +mate_mixer_stream_get_max_volume +mate_mixer_stream_get_normal_volume +MateMixerStream +<SUBSECTION Standard> +MATE_MIXER_IS_STREAM +MATE_MIXER_STREAM +MATE_MIXER_STREAM_GET_INTERFACE +MATE_MIXER_TYPE_STREAM +mate_mixer_stream_get_type +</SECTION> + +<SECTION> +<FILE>matemixer-version</FILE> +LIBMATEMIXER_MAJOR_VERSION +LIBMATEMIXER_MINOR_VERSION +LIBMATEMIXER_MICRO_VERSION +LIBMATEMIXER_VERSION +LIBMATEMIXER_CHECK_VERSION +</SECTION> + diff --git a/docs/reference/libmatemixer.types b/docs/reference/libmatemixer.types new file mode 100644 index 0000000..be96363 --- /dev/null +++ b/docs/reference/libmatemixer.types @@ -0,0 +1,6 @@ +mate_mixer_client_stream_get_type +mate_mixer_control_get_type +mate_mixer_device_get_type +mate_mixer_port_get_type +mate_mixer_profile_get_type +mate_mixer_stream_get_type diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in new file mode 100644 index 0000000..6f8d6bf --- /dev/null +++ b/docs/reference/version.xml.in @@ -0,0 +1 @@ +@LIBMATEMIXER_VERSION@ |