totem-pl-parser r30 - in trunk: . docs docs/reference

[hadess svn gnome org]

Author: hadess
Date: Tue Jan  8 10:03:28 2008
New Revision: 30
URL: http://svn.gnome.org/viewvc/totem-pl-parser?rev=30&view=rev

Log:
2008-01-08  Bastien Nocera  <hadess hadess net>

	* Makefile.am:
	* configure.in:
	* docs/reference/MODULE.types:
	* docs/reference/Makefile.am: Add the beginnings of gtk-doc
	support



Added:
   trunk/docs/
   trunk/docs/reference/
   trunk/docs/reference/MODULE.types
   trunk/docs/reference/Makefile.am
Modified:
   trunk/ChangeLog
   trunk/Makefile.am
   trunk/configure.in

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Tue Jan  8 10:03:28 2008
@@ -1,4 +1,4 @@
-SUBDIRS = lib plparse po
+SUBDIRS = lib plparse po docs
 
 EXTRA_DIST =			\
 	COPYING.LIB		\
@@ -7,13 +7,14 @@
 	intltool-merge.in	\
 	intltool-update.in	\
 	AUTHORS NEWS		\
+	gtk-doc.make		\
 	totem-plparser.pc.in	\
 	totem-plparser-mini.pc
 
 CLEANFILES = totem-plparser.pc
 
 DISTCLEANFILES = intltool-extract intltool-merge intltool-update \
-		 gnome-doc-utils.make
+		 gnome-doc-utils.make gtk-doc.make
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = totem-plparser.pc totem-plparser-mini.pc

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Tue Jan  8 10:03:28 2008
@@ -102,6 +102,8 @@
 AC_SUBST([AM_CXXFLAGS])
 AC_SUBST([AM_LDFLAGS])
 
+GTK_DOC_CHECK(1.0)
+
 AC_OUTPUT([
 Makefile
 totem-plparser.pc
@@ -112,6 +114,8 @@
 plparse/Makefile
 plparse/totem-pl-parser-features.h
 po/Makefile.in
+docs/Makefile
+docs/reference/Makefile
 ])
 
 AC_MSG_NOTICE([totem-pl-parser was configured with the following options:])

Added: trunk/docs/reference/MODULE.types
==============================================================================
--- (empty file)
+++ trunk/docs/reference/MODULE.types	Tue Jan  8 10:03:28 2008
@@ -0,0 +1,3 @@
+#include <totem-pl-parser.h>
+
+totem_pl_parser_get_type

Added: trunk/docs/reference/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/reference/Makefile.am	Tue Jan  8 10:03:28 2008
@@ -0,0 +1,97 @@
+## 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=totem-pl-parser
+
+# 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=../../plparse
+
+# 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)/plparse/*.h
+CFILE_GLOB=$(top_srcdir)/plparse/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=					\
+	bswap.h					\
+	stamp-totem-pl-parser-builtins.h	\
+	totem-pl-parser-builtins.h		\
+	totem-pl-parser-features.h		\
+	totem-pl-parser-lines.h			\
+	totemplparser-marshal.h			\
+	totem-pl-parser-media.h			\
+	totem-pl-parser-mini.h			\
+	totem-pl-parser-misc.h			\
+	totem-pl-parser-pla.h			\
+	totem-pl-parser-pls.h			\
+	totem-pl-parser-podcast.h		\
+	totem-pl-parser-private.h		\
+	totem-pl-parser-qt.h			\
+	totem-pl-parser-smil.h			\
+	totem-pl-parser-wm.h			\
+	totem-pl-parser-xspf.h			\
+	xmllexer.h				\
+	xmlparser.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. 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) $(TOTEM_PLPARSER_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/plparse/libtotem-plparser.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 +=