[clutter-gst/clutter-gst-3.0] build: Clean up the API reference build



commit 9247f90c44e37b1266fcd187c63c50e26ed30ba1
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Sun Jun 19 12:33:29 2016 +0100

    build: Clean up the API reference build
    
    Don't use deprecated variables and arguments.

 doc/reference/Makefile.am                          |   87 ++++----------------
 ...{clutter-gst-docs.sgml => clutter-gst-docs.xml} |    0
 2 files changed, 17 insertions(+), 70 deletions(-)
---
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 7b46775..23e1374 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -1,45 +1,15 @@
-## Process this file with automake to produce Makefile.in
 NULL = #
 
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
+DOC_MODULE = clutter-gst
+DOC_MODULE_VERSION = @CLUTTER_GST_API_VERSION@
+DOC_MAIN_SGML_FILE = clutter-gst-docs.xml
+DOC_SOURCE_DIR = $(top_srcdir)/clutter-gst $(top_builddir)/clutter-gst
 
-# 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=clutter-gst
-DOC_MODULE_VERSION= CLUTTER_GST_API_VERSION@
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=clutter-gst-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=../../clutter-gst
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=--type-init-func="clutter_gst_init(0,0)"
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--rebuild-types
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=clutter_gst
-
-# 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= \
+SCANGOBJ_OPTIONS = --type-init-func="extern void clutter_gst_init (int *, char **); clutter_gst_init(0,0)"
+SCAN_OPTIONS = --rebuild-types
+MKDB_OPTIONS = --xml-mode --output-format=xml --name-space=clutter_gst
+MKTMPL_OPTIONS =
+FIXXREF_OPTIONS = \
        --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
        --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
        --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/cogl \
@@ -48,47 +18,24 @@ FIXXREF_OPTIONS= \
        --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gstreamer-1.0 \
        $(NULL)
 
-# 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)/clutter-gst/*.h
-CFILE_GLOB=$(top_srcdir)/clutter-gst/*.c
+HFILE_GLOB = $(top_srcdir)/clutter-gst/*.h $(top_builddir)/clutter-gst/*.h
+CFILE_GLOB = $(top_srcdir)/clutter-gst/*.c
 
-# Header files to ignore when scanning.
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=                         \
+IGNORE_HFILES =                                \
        clutter-gst.h                   \
        clutter-gst-debug.h             \
        clutter-gst-private.h           \
        clutter-gst-auto-video-sink.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= version.xml
-
-# 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=
+HTML_IMAGES =
 
-# 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)
+content_files = version.xml
+expand_content_files =
 
-# FIXME:  $(GST_CFLAGS) needed for clutter_media metadata - togo..
-INCLUDES=-I$(top_srcdir) $(CLUTTER_GST_CFLAGS) $(GST_CFLAGS)
-GTKDOC_LIBS=$(top_builddir)/clutter-gst/libclutter-gst- CLUTTER_GST_MAJORMINOR@.la $(CLUTTER_GST_LIBS)
+GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_builddir) $(CLUTTER_GST_CFLAGS) $(GST_CFLAGS)
+GTKDOC_LIBS = $(top_builddir)/clutter-gst/libclutter-gst- CLUTTER_GST_MAJORMINOR@.la $(CLUTTER_GST_LIBS)
 
-# 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
diff --git a/doc/reference/clutter-gst-docs.sgml b/doc/reference/clutter-gst-docs.xml
similarity index 100%
rename from doc/reference/clutter-gst-docs.sgml
rename to doc/reference/clutter-gst-docs.xml


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]