nautilus-cd-burner r2264 - in trunk: . doc doc/reference

[hadess svn gnome org]

Author: hadess
Date: Tue Dec 16 16:46:18 2008
New Revision: 2264
URL: http://svn.gnome.org/viewvc/nautilus-cd-burner?rev=2264&view=rev

Log:
2008-12-16  Bastien Nocera  <hadess hadess net>

	* Makefile.am:
	* configure.in:
	* doc/Makefile.am:
	* doc/reference/Makefile.am:
	* doc/reference/nautilus-cd-burner-docs.sgml:
	* doc/reference/version.xml.in: Patch from Frederic Peters
	<fpeters 0d be> to create gtk-doc documentation for
	libnautilus-burn (Closes: #364539)



Added:
   trunk/doc/
   trunk/doc/Makefile.am
   trunk/doc/reference/
   trunk/doc/reference/Makefile.am
   trunk/doc/reference/nautilus-cd-burner-docs.sgml
   trunk/doc/reference/version.xml.in
Modified:
   trunk/ChangeLog
   trunk/Makefile.am
   trunk/configure.in

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Tue Dec 16 16:46:18 2008
@@ -8,6 +8,7 @@
 	src			\
 	po 			\
 	data			\
+	doc			\
 	$(NULL)
 
 EXTRA_DIST =			\

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Tue Dec 16 16:46:18 2008
@@ -187,6 +187,9 @@
     fi
 fi
 
+# check for gtk-doc
+GTK_DOC_CHECK(1.8)
+
 AC_CONFIG_FILES([
 Makefile
 data/Makefile
@@ -199,6 +202,9 @@
 data/libnautilus-burn.pc
 src/nautilus-burn-features.h
 po/Makefile.in
+doc/Makefile
+doc/reference/Makefile
+doc/reference/version.xml
 ])
 
 AC_OUTPUT

Added: trunk/doc/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/doc/Makefile.am	Tue Dec 16 16:46:18 2008
@@ -0,0 +1 @@
+SUBDIRS = reference

Added: trunk/doc/reference/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/doc/reference/Makefile.am	Tue Dec 16 16:46:18 2008
@@ -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=nautilus-cd-burner
+
+# 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=../../src
+
+# 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-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)/src/nautilus-burn*.h
+CFILE_GLOB=$(top_srcdir)/src/nautilus-burn*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=nautilus-burn-bar.h \
+	nautilus-burn-drive-private.h \
+	nautilus-burn-drive-monitor-private.h \
+	nautilus-burn-recorder-marshal.h \
+	make-iso.h \
+	mapping-daemon.h \
+	mapping-method.h \
+	mapping-protocol.h \
+	mkdtemp.h \
+	nautilus-cd-burner.h \
+	nautilus-file-operations-progress-icons.h \
+	ncb-operation.h \
+	ncb-progress-dialog.h \
+	ncb-rename-dialog.h \
+	ncb-selection-dialog.h \
+	ncb-selection.h \
+	$(NULL)
+
+# 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=-I$(top_srcdir) -I$(top_builddir) $(BURN_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/src/libnautilus-burn.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 += version.xml.in

Added: trunk/doc/reference/nautilus-cd-burner-docs.sgml
==============================================================================
--- (empty file)
+++ trunk/doc/reference/nautilus-cd-burner-docs.sgml	Tue Dec 16 16:46:18 2008
@@ -0,0 +1,20 @@
+<?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>libnautilus-burn Reference Manual</title>
+    <xi:include href="version.xml"/>
+  </bookinfo>
+
+  <chapter>
+    <title>libnautilus-burn Reference Manual</title>
+    <xi:include href="xml/nautilus-burn-init.xml"/>
+    <xi:include href="xml/nautilus-burn-features.xml"/>
+    <xi:include href="xml/nautilus-burn-drive.xml"/>
+    <xi:include href="xml/nautilus-burn-drive-selection.xml"/>
+    <xi:include href="xml/nautilus-burn-drive-monitor.xml"/>
+    <xi:include href="xml/nautilus-burn-recorder.xml"/>
+    <xi:include href="xml/nautilus-burn-process.xml"/>
+  </chapter>
+</book>

Added: trunk/doc/reference/version.xml.in
==============================================================================
--- (empty file)
+++ trunk/doc/reference/version.xml.in	Tue Dec 16 16:46:18 2008
@@ -0,0 +1 @@
+<releaseinfo>@VERSION@</releaseinfo>