updated added build docs/ and enable gtk-doc for distcheck add macro dir,

2006-03-26  Vincent Untz  <vuntz@gnome.org>

	* .cvsignore: updated
	* m4/.cvsignore: added
	* Makefile.am: build docs/ and enable gtk-doc for distcheck
	* configure.in: add macro dir, check for gtk-doc
	* docs/*: add API documentation
	Fix bug #166160

9 files changed, 270 insertions, 0 deletions

diff --git a/docs/.cvsignore b/docs/.cvsignore
new file mode 100644
index 00000000..282522db
--- /dev/null
+++ b/docs/.cvsignore
@@ -0,0 +1,2 @@
+Makefile
+Makefile.in
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/.cvsignore b/docs/reference/.cvsignore
new file mode 100644
index 00000000..282522db
--- /dev/null
+++ b/docs/reference/.cvsignore
@@ -0,0 +1,2 @@
+Makefile
+Makefile.in
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 00000000..e7810705
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = gnome-desktop
diff --git a/docs/reference/gnome-desktop/.cvsignore b/docs/reference/gnome-desktop/.cvsignore
new file mode 100644
index 00000000..a88c617b
--- /dev/null
+++ b/docs/reference/gnome-desktop/.cvsignore
@@ -0,0 +1,16 @@
+Makefile
+Makefile.in
+html
+xml
+*.stamp
+gnome-desktop.args
+gnome-desktop.hierarchy
+gnome-desktop.signals
+gnome-desktop-decl.txt
+gnome-desktop-decl-list.txt
+gnome-desktop-overrides.txt
+gnome-desktop-undocumented.txt
+gnome-desktop-unused.txt
+gnome-desktop.interfaces
+gnome-desktop.prerequisites
+tmpl
diff --git a/docs/reference/gnome-desktop/Makefile.am b/docs/reference/gnome-desktop/Makefile.am
new file mode 100644
index 00000000..d46a0357
--- /dev/null
+++ b/docs/reference/gnome-desktop/Makefile.am
@@ -0,0 +1,78 @@
+## 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-desktop
+
+# 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=../../../libgnome-desktop
+
+# 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=--deprecated-guards="GNOME_DISABLE_DEPRECATED"
+
+# 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=$(top_srcdir)/libgnome-desktop/libgnome/*.h $(top_srcdir)/libgnome-desktop/libgnomeui/*.h
+CFILE_GLOB=$(top_srcdir)/libgnome-desktop/*.c
+
+# 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=$(GNOME_DESKTOP_CFLAGS) -I$(top_builddir)/libgnome-desktop
+GTKDOC_LIBS=$(GNOME_DESKTOP_LIBS) $(top_builddir)/libgnome-desktop/libgnome-desktop-2.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 += 
diff --git a/docs/reference/gnome-desktop/gnome-desktop-docs.sgml b/docs/reference/gnome-desktop/gnome-desktop-docs.sgml
new file mode 100644
index 00000000..a1b1feb8
--- /dev/null
+++ b/docs/reference/gnome-desktop/gnome-desktop-docs.sgml
@@ -0,0 +1,24 @@
+<?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>GNOME Desktop Library Reference Manual</title>
+  </bookinfo>
+
+  <part id="intro">
+   <title>GNOME Desktop Library Overview</title>
+   <partintro>
+    <para>
+The libgnome-desktop library contains APIs that really belong in libgnome[ui] but have not seen enough testing or development to be considered stable. Use at your own risk.
+    </para>
+   </partintro>
+  </part>
+
+  <chapter>
+    <title>API reference</title>
+    <xi:include href="xml/gnome-ditem-edit.xml"/>
+    <xi:include href="xml/gnome-hint.xml"/>
+    <xi:include href="xml/gnome-desktop-item.xml"/>
+  </chapter>
+</book>
diff --git a/docs/reference/gnome-desktop/gnome-desktop-sections.txt b/docs/reference/gnome-desktop/gnome-desktop-sections.txt
new file mode 100644
index 00000000..b76c375d
--- /dev/null
+++ b/docs/reference/gnome-desktop/gnome-desktop-sections.txt
@@ -0,0 +1,139 @@
+<SECTION>
+<INCLUDE>libgnome/gnome-ditem-edit.h</INCLUDE>
+<FILE>gnome-ditem-edit</FILE>
+<TITLE>GnomeDItemEdit</TITLE>
+GnomeDItemEdit
+gnome_ditem_edit_new
+gnome_ditem_edit_clear
+gnome_ditem_edit_load_uri
+gnome_ditem_edit_set_ditem
+gnome_ditem_edit_get_ditem
+gnome_ditem_edit_get_icon
+gnome_ditem_edit_get_name
+gnome_ditem_edit_set_entry_type
+gnome_ditem_edit_set_directory_only
+gnome_ditem_edit_grab_focus
+gnome_ditem_edit_set_editable
+<SUBSECTION Standard>
+GnomeDItemEditClass
+GNOME_DITEM_EDIT
+GNOME_IS_DITEM_EDIT
+GNOME_TYPE_DITEM_EDIT
+gnome_ditem_edit_get_type
+GNOME_DITEM_EDIT_CLASS
+GNOME_IS_DITEM_EDIT_CLASS
+GNOME_DITEM_EDIT_GET_CLASS
+<SUBSECTION Private>
+GnomeDItemEditPrivate
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-hint.h</INCLUDE>
+<FILE>gnome-hint</FILE>
+<TITLE>GnomeHint</TITLE>
+GnomeHint
+gnome_hint_new
+<SUBSECTION Standard>
+GnomeHintClass
+GNOME_HINT
+GNOME_IS_HINT
+GNOME_TYPE_HINT
+gnome_hint_get_type
+GNOME_HINT_CLASS
+GNOME_IS_HINT_CLASS
+GNOME_HINT_GET_CLASS
+<SUBSECTION Private>
+GnomeHintPrivate
+</SECTION>
+
+<SECTION>
+<INCLUDE>libgnomeui/gnome-desktop-item.h</INCLUDE>
+<FILE>gnome-desktop-item</FILE>
+<TITLE>GnomeDesktopItem</TITLE>
+GnomeDesktopItemType
+GnomeDesktopItemStatus
+GnomeDesktopItem
+GNOME_DESKTOP_ITEM_ENCODING
+GNOME_DESKTOP_ITEM_VERSION
+GNOME_DESKTOP_ITEM_NAME
+GNOME_DESKTOP_ITEM_GENERIC_NAME
+GNOME_DESKTOP_ITEM_TYPE
+GNOME_DESKTOP_ITEM_FILE_PATTERN
+GNOME_DESKTOP_ITEM_TRY_EXEC
+GNOME_DESKTOP_ITEM_NO_DISPLAY
+GNOME_DESKTOP_ITEM_COMMENT
+GNOME_DESKTOP_ITEM_EXEC
+GNOME_DESKTOP_ITEM_ACTIONS
+GNOME_DESKTOP_ITEM_ICON
+GNOME_DESKTOP_ITEM_MINI_ICON
+GNOME_DESKTOP_ITEM_HIDDEN
+GNOME_DESKTOP_ITEM_PATH
+GNOME_DESKTOP_ITEM_TERMINAL
+GNOME_DESKTOP_ITEM_TERMINAL_OPTIONS
+GNOME_DESKTOP_ITEM_SWALLOW_TITLE
+GNOME_DESKTOP_ITEM_SWALLOW_EXEC
+GNOME_DESKTOP_ITEM_MIME_TYPE
+GNOME_DESKTOP_ITEM_PATTERNS
+GNOME_DESKTOP_ITEM_DEFAULT_APP
+GNOME_DESKTOP_ITEM_DEV
+GNOME_DESKTOP_ITEM_FS_TYPE
+GNOME_DESKTOP_ITEM_MOUNT_POINT
+GNOME_DESKTOP_ITEM_READ_ONLY
+GNOME_DESKTOP_ITEM_UNMOUNT_ICON
+GNOME_DESKTOP_ITEM_SORT_ORDER
+GNOME_DESKTOP_ITEM_URL
+GNOME_DESKTOP_ITEM_DOC_PATH
+GNOME_DESKTOP_ITEM_CATEGORIES
+GNOME_DESKTOP_ITEM_ONLY_SHOW_IN
+GnomeDesktopItemLoadFlags
+GnomeDesktopItemLaunchFlags
+GnomeDesktopItemIconFlags
+GnomeDesktopItemError
+GNOME_DESKTOP_ITEM_ERROR
+gnome_desktop_item_new
+gnome_desktop_item_new_from_file
+gnome_desktop_item_new_from_uri
+gnome_desktop_item_new_from_string
+gnome_desktop_item_new_from_basename
+gnome_desktop_item_copy
+gnome_desktop_item_save
+gnome_desktop_item_ref
+gnome_desktop_item_unref
+gnome_desktop_item_launch
+gnome_desktop_item_launch_with_env
+gnome_desktop_item_launch_on_screen
+gnome_desktop_item_drop_uri_list
+gnome_desktop_item_drop_uri_list_with_env
+gnome_desktop_item_exists
+gnome_desktop_item_get_entry_type
+gnome_desktop_item_set_entry_type
+gnome_desktop_item_get_location
+gnome_desktop_item_set_location
+gnome_desktop_item_set_location_file
+gnome_desktop_item_get_file_status
+gnome_desktop_item_get_icon
+gnome_desktop_item_find_icon
+gnome_desktop_item_attr_exists
+gnome_desktop_item_get_string
+gnome_desktop_item_set_string
+gnome_desktop_item_get_attr_locale
+gnome_desktop_item_get_localestring
+gnome_desktop_item_get_localestring_lang
+gnome_desktop_item_get_languages
+gnome_desktop_item_set_localestring
+gnome_desktop_item_set_localestring_lang
+gnome_desktop_item_clear_localestring
+gnome_desktop_item_get_strings
+gnome_desktop_item_set_strings
+gnome_desktop_item_get_boolean
+gnome_desktop_item_set_boolean
+gnome_desktop_item_set_launch_time
+gnome_desktop_item_clear_attr
+gnome_desktop_item_clear_section
+<SUBSECTION Standard>
+GNOME_TYPE_DESKTOP_ITEM
+gnome_desktop_item_get_type
+<SUBSECTION Private>
+gnome_desktop_item_error_quark
+</SECTION>
+
diff --git a/docs/reference/gnome-desktop/gnome-desktop.types b/docs/reference/gnome-desktop/gnome-desktop.types
new file mode 100644
index 00000000..3f5908e0
--- /dev/null
+++ b/docs/reference/gnome-desktop/gnome-desktop.types
@@ -0,0 +1,7 @@
+#include <libgnome/gnome-desktop-item.h>
+#include <libgnomeui/gnome-ditem-edit.h>
+#include <libgnomeui/gnome-hint.h>
+
+gnome_desktop_item_get_type
+gnome_ditem_edit_get_type
+gnome_hint_get_type