gnome-bluetooth r368 - in trunk: . docs docs/reference docs/reference/libgnome-bluetooth

[hadess svn gnome org]

Author: hadess
Date: Thu Feb 26 15:13:11 2009
New Revision: 368
URL: http://svn.gnome.org/viewvc/gnome-bluetooth?rev=368&view=rev

Log:
Add gtk-doc support

Nothing documented just yet.

Added:
   trunk/docs/Makefile.am
   trunk/docs/reference/
   trunk/docs/reference/Makefile.am
   trunk/docs/reference/libgnome-bluetooth/
   trunk/docs/reference/libgnome-bluetooth/Makefile.am
   trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml
   trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt
   trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth.types
Modified:
   trunk/Makefile.am
   trunk/configure.ac

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Thu Feb 26 15:13:11 2009
@@ -1,10 +1,11 @@
 
-SUBDIRS = po icons common applet properties wizard sendto
+SUBDIRS = icons common applet properties wizard sendto docs po
 
-EXTRA_DIST = intltool-extract.in intltool-update.in intltool-merge.in ChangeLog.pre-2.27
+EXTRA_DIST = intltool-extract.in intltool-update.in intltool-merge.in ChangeLog.pre-2.27 gtk-doc.make
 
 DISTCHECK_CONFIGURE_FLAGS = --disable-schemas-install \
-	--disable-desktop-update --disable-mime-update --disable-icon-update
+	--disable-desktop-update --disable-mime-update --disable-icon-update \
+	--enable-gtk-doc
 
 DISTCLEANFILES = intltool-extract intltool-update intltool-merge
 

Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac	(original)
+++ trunk/configure.ac	Thu Feb 26 15:13:11 2009
@@ -35,6 +35,9 @@
 AC_PATH_PROG(GCONFTOOL, [gconftool-2])
 AM_GCONF_SOURCE_2
 
+dnl gtk-doc checks
+GTK_DOC_CHECK(1.9)
+
 AC_DEFINE_UNQUOTED(LOCALEDIR, "${prefix}/share/locale", [Directory for the localization files])
 
 AC_ARG_ENABLE(desktop-update, AC_HELP_STRING([--disable-desktop-update],
@@ -112,6 +115,9 @@
 	  properties/Makefile
 	  wizard/Makefile
 	  sendto/Makefile
+	  docs/Makefile
+	  docs/reference/Makefile
+	  docs/reference/libgnome-bluetooth/Makefile
 	  po/Makefile.in
 )
 

Added: trunk/docs/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/Makefile.am	Thu Feb 26 15:13:11 2009
@@ -0,0 +1 @@
+SUBDIRS = reference

Added: trunk/docs/reference/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/reference/Makefile.am	Thu Feb 26 15:13:11 2009
@@ -0,0 +1 @@
+SUBDIRS = libgnome-bluetooth

Added: trunk/docs/reference/libgnome-bluetooth/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libgnome-bluetooth/Makefile.am	Thu Feb 26 15:13:11 2009
@@ -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)
+

Added: trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth-docs.sgml	Thu Feb 26 15:13:11 2009
@@ -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>

Added: trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt	Thu Feb 26 15:13:11 2009
@@ -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>
+

Added: trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth.types
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libgnome-bluetooth/gnome-bluetooth.types	Thu Feb 26 15:13:11 2009
@@ -0,0 +1,2 @@
+bluetooth_chooser_get_type
+bluetooth_chooser_button_get_type