nautilus r14041 - in trunk: . docs docs/reference docs/reference/libnautilus-extension

[awalton svn gnome org]

Author: awalton
Date: Sat Apr  5 02:42:52 2008
New Revision: 14041
URL: http://svn.gnome.org/viewvc/nautilus?rev=14041&view=rev

Log:
	Adds initial Gtk-doc support infrastructure for 
libnautilus-extension.
	(Progress towards bug #526193).



Added:
   trunk/docs/reference/
   trunk/docs/reference/Makefile.am
   trunk/docs/reference/libnautilus-extension/
   trunk/docs/reference/libnautilus-extension/Makefile.am
   trunk/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml
   trunk/docs/reference/libnautilus-extension/libnautilus-extension.types
   trunk/docs/reference/libnautilus-extension/version.xml.in
Modified:
   trunk/ChangeLog
   trunk/configure.in
   trunk/docs/Makefile.am

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Sat Apr  5 02:42:52 2008
@@ -118,6 +118,12 @@
 
 dnl ==========================================================================
 
+GTK_DOC_CHECK
+DISTCHECK_CONFIGURE_FLAGS="--enable-gtk-doc"
+AC_SUBST(DISTCHECK_CONFIGURE_FLAGS)
+
+dnl ==========================================================================
+
 ENABLE_PROFILER=
 AC_ARG_ENABLE(profiler,
  AC_HELP_STRING([--enable-profiler], [Enable profiler]),
@@ -479,6 +485,9 @@
 data/icons/scalable/apps/Makefile
 data/patterns/Makefile
 docs/Makefile
+docs/reference/Makefile
+docs/reference/libnautilus-extension/Makefile
+docs/reference/libnautilus-extension/version.xml
 icons/Makefile
 libbackground/Makefile
 libnautilus-private/Makefile
@@ -511,4 +520,5 @@
 	beagle support:		$msg_beagle
 
 	profiling support:      ${profiling_support}
+	nautilus-extension documentation: ${enable_gtk_doc}
 "

Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am	(original)
+++ trunk/docs/Makefile.am	Sat Apr  5 02:42:52 2008
@@ -1,5 +1,7 @@
 NULL = 
 
+SUBDIRS = reference
+
 EXTRA_DIST = \
 	architecture.txt \
 	dnd.txt \

Added: trunk/docs/reference/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/reference/Makefile.am	Sat Apr  5 02:42:52 2008
@@ -0,0 +1 @@
+SUBDIRS = libnautilus-extension

Added: trunk/docs/reference/libnautilus-extension/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libnautilus-extension/Makefile.am	Sat Apr  5 02:42:52 2008
@@ -0,0 +1,74 @@
+## 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=libnautilus-extension
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+
+# 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=../../../libnautilus-extension
+DOC_SOURCE_DIR=$(top_srcdir)/libnautilus-extension
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=--type-init-func="g_type_init()"
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
+SCAN_OPTIONS=--deprecated-guards="G_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=
+
+HFILE_GLOB=$(top_srcdir)/libnautilus-extension/*.h
+CFILE_GLOB=$(top_srcdir)/libnautilus-extension/*.c
+
+IGNORE_HFILES= \
+	$(NULL)
+
+EXTRA_HFILES= \
+	$(NULL)
+	
+HTML_IMAGES= 
+
+content_files= \
+	version.xml \
+	$(NULL)
+
+# 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= \
+		$(NULL) 
+
+# 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=-I$(top_srcdir) $(CORE_CFLAGS)
+GTKDOC_LIBS= -L$(top_builddir) $(CORE_LIBS) \
+	$(top_builddir)/libnautilus-extension/libnautilus-extension.la \
+	$(NULL)
+
+# 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

Added: trunk/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libnautilus-extension/libnautilus-extension-docs.xml	Sat Apr  5 02:42:52 2008
@@ -0,0 +1,36 @@
+<?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"; [
+<!ENTITY version SYSTEM "version.xml">
+]>
+
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
+  <bookinfo>
+    <title>Nautilus Extension Reference Manual</title>
+    <releaseinfo>For Nautilus-Extension &version;</releaseinfo>
+
+    </bookinfo>
+
+  <part>
+    <title>API Reference</title>
+
+    <chapter>
+      <title>Extension Interfaces</title>
+      <xi:include href="xml/nautilus-column-provider.xml" />
+      <xi:include href="xml/nautilus-column.xml" />
+      <xi:include href="xml/nautilus-extension-i18n.xml" />
+      <xi:include href="xml/nautilus-extension-types.xml" />
+      <xi:include href="xml/nautilus-file-info.xml" />
+      <xi:include href="xml/nautilus-info-provider.xml" />
+      <xi:include href="xml/nautilus-location-widget-provider.xml" />
+      <xi:include href="xml/nautilus-menu-provider.xml" />
+      <xi:include href="xml/nautilus-menu.xml" />
+      <xi:include href="xml/nautilus-property-page-provider.xml" />
+      <xi:include href="xml/nautilus-property-page.xml" />
+    </chapter>
+
+  </part>
+  <index>
+    <title id="index-all">Index</title>
+  </index>
+</book>

Added: trunk/docs/reference/libnautilus-extension/libnautilus-extension.types
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libnautilus-extension/libnautilus-extension.types	Sat Apr  5 02:42:52 2008
@@ -0,0 +1,11 @@
+nautilus_property_page_provider_get_type
+nautilus_location_widget_provider_get_type
+nautilus_operation_result_get_type
+nautilus_file_info_get_type
+nautilus_property_page_get_type
+nautilus_info_provider_get_type
+nautilus_column_get_type
+nautilus_column_provider_get_type
+nautilus_menu_provider_get_type
+nautilus_menu_get_type
+nautilus_menu_item_get_type

Added: trunk/docs/reference/libnautilus-extension/version.xml.in
==============================================================================
--- (empty file)
+++ trunk/docs/reference/libnautilus-extension/version.xml.in	Sat Apr  5 02:42:52 2008
@@ -0,0 +1 @@
+ NAUTILUS_EXTENSION_VERSION_INFO@