diff options
author | Bastien Nocera <hadess@src.gnome.org> | 2009-02-26 15:13:11 +0000 |
---|---|---|
committer | Bastien Nocera <hadess@src.gnome.org> | 2009-02-26 15:13:11 +0000 |
commit | 519e619661567cd4988baea5c7214c358d771071 (patch) | |
tree | e817f1a8ee899ee712b33aa223e1cd8f8575a5a5 /docs | |
parent | 944cb1288e75377b390a46512cece1ee3b8844eb (diff) | |
download | gnome-bluetooth-519e619661567cd4988baea5c7214c358d771071.tar.gz |
Add gtk-doc support
Nothing documented just yet.
svn path=/trunk/; revision=368
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 1 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 1 | ||||
-rw-r--r-- | docs/reference/libgnome-bluetooth/Makefile.am | 94 | ||||
-rw-r--r-- | docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml | 34 | ||||
-rw-r--r-- | docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt | 38 | ||||
-rw-r--r-- | docs/reference/libgnome-bluetooth/gnome-bluetooth.types | 2 |
6 files changed, 170 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 00000000..f3ddc22d --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = reference diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 00000000..de5797c3 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = libgnome-bluetooth diff --git a/docs/reference/libgnome-bluetooth/Makefile.am b/docs/reference/libgnome-bluetooth/Makefile.am new file mode 100644 index 00000000..19cc2277 --- /dev/null +++ b/docs/reference/libgnome-bluetooth/Makefile.am @@ -0,0 +1,94 @@ +## 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=gnome-bluetooth + +# 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.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=../../../common + +# 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-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= +CFILE_GLOB= + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=bluetooth-agent-glue.h bluetooth-agent.h bluetooth-client-glue.h bluetooth-client.h bluetooth-instance-glue.h bluetooth-instance.h helper.h marshal.h obex-agent-glue.h obex-agent.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=$(LIBGNOMEBT_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/common/libgnome-bluetooth.la $(top_builddir)/common/libcommon.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 your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml b/docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml new file mode 100644 index 00000000..62c7f492 --- /dev/null +++ b/docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml @@ -0,0 +1,34 @@ +<?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>gnome-bluetooth Reference Manual</title> + <releaseinfo> + for gnome-bluetooth [VERSION]. + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/gnome-bluetooth/index.html">http://[SERVER]/gnome-bluetooth/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>[Insert title here]</title> + <xi:include href="xml/bluetooth-chooser.xml"/> + <xi:include href="xml/bluetooth-chooser-button.xml"/> + <xi:include href="xml/bluetooth-enums.xml"/> + + </chapter> + <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> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt b/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt new file mode 100644 index 00000000..da84a73b --- /dev/null +++ b/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt @@ -0,0 +1,38 @@ +<SECTION> +<FILE>bluetooth-chooser</FILE> +BLUETOOTH_GET_CHOOSER_CLASS +<TITLE>BluetoothChooser</TITLE> +BluetoothChooser +bluetooth_chooser_new +bluetooth_chooser_set_title +bluetooth_chooser_get_selected_device +bluetooth_chooser_get_selected_device_name +bluetooth_chooser_get_selected_device_icon +bluetooth_chooser_start_discovery +<SUBSECTION Standard> +BLUETOOTH_CHOOSER +BLUETOOTH_IS_CHOOSER +BLUETOOTH_TYPE_CHOOSER +bluetooth_chooser_get_type +BLUETOOTH_CHOOSER_CLASS +BLUETOOTH_IS_CHOOSER_CLASS +</SECTION> + +<SECTION> +<FILE>bluetooth-chooser-button</FILE> +<TITLE>BluetoothChooserButton</TITLE> +BluetoothChooserButton +bluetooth_chooser_button_new +bluetooth_chooser_button_available +<SUBSECTION Standard> +BLUETOOTH_CHOOSER_BUTTON +BLUETOOTH_IS_CHOOSER_BUTTON +BLUETOOTH_TYPE_CHOOSER_BUTTON +bluetooth_chooser_button_get_type +</SECTION> + +<SECTION> +<FILE>bluetooth-enums</FILE> +BLUETOOTH_TYPE_INPUT +</SECTION> + diff --git a/docs/reference/libgnome-bluetooth/gnome-bluetooth.types b/docs/reference/libgnome-bluetooth/gnome-bluetooth.types new file mode 100644 index 00000000..db54f6a0 --- /dev/null +++ b/docs/reference/libgnome-bluetooth/gnome-bluetooth.types @@ -0,0 +1,2 @@ +bluetooth_chooser_get_type +bluetooth_chooser_button_get_type |