[gnome-panel] doc: update Makefile from latest example

[Alberts Muktupāvels <muktupavels src gnome org>]

commit 40c15c4fd25a28dc897959057239516cf0a16652
Author: Alberts Muktupāvels <alberts muktupavels gmail com>
Date:   Sat Sep 12 02:07:19 2015 +0300

    doc: update Makefile from latest example

 doc/reference/panel-applet/Makefile.am |  142 +++++++++++++++++++-------------
 1 files changed, 86 insertions(+), 56 deletions(-)
---
diff --git a/doc/reference/panel-applet/Makefile.am b/doc/reference/panel-applet/Makefile.am
index 2083cb8..a85adb9 100644
--- a/doc/reference/panel-applet/Makefile.am
+++ b/doc/reference/panel-applet/Makefile.am
@@ -1,73 +1,103 @@
-## Process this file with automake to produce Makefile.in
-
-AUTOMAKE_OPTIONS = 1.6
+NULL =
 
 # The name of the module, e.g. 'glib'.
-DOC_MODULE=panel-applet
-DOC_MODULE_VERSION=$(LIBPANEL_APPLET_API_VERSION)
-
-# The top-level SGML file. Change it if you want.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+DOC_MODULE = panel-applet
 
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting functions and macros.
-DOC_SOURCE_DIR=../../../libpanel-applet
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+DOC_MODULE_VERSION = $(LIBPANEL_APPLET_API_VERSION)
 
-# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=--rebuild-types
+# The top-level XML file.
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
 
-# Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--xml-mode --output-format=xml
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR = $(top_srcdir)/libpanel-applet
 
-# Extra options to supply to gtkdoc-fixref.
-FIXXREF_OPTIONS=
+# Extra options to pass to gtkdoc-scangobj. Normally not needed.
+SCANGOBJ_OPTIONS =
 
-# Used for dependencies.
-HFILE_GLOB=$(top_srcdir)/libpanel-applet/*.h
-CFILE_GLOB=$(top_srcdir)/libpanel-applet/*.c
-
-# Header files to ignore when scanning.
-IGNORE_HFILES =                                        \
-       panel-applet-bindings.h                 \
-       panel-applet-enums.h                    \
-       panel-applet-factory.h                  \
-       panel-applet-marshal.h
+# 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=--xml-mode --output-format=xml
+MKDB_OPTIONS = --xml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS =
+
+# Extra options to supply to gtkdoc-fixref. Normally not 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)/libpanel-applet/*.h
+CFILE_GLOB = $(top_srcdir)/libpanel-applet/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES =
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES = \
+       panel-applet-bindings.h \
+       panel-applet-enums.h \
+       panel-applet-factory.h \
+       panel-applet-marshal.h \
+       $(NULL)
 
 # Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
 HTML_IMAGES = \
-       add_to_panel.png
+       add_to_panel.png \
+       $(NULL)
 
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# Extra files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.xml building.xml changes-2.0.xml
 content_files = \
-       version.xml
-
-# Other files to distribute.
-extra_files =
-
-# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
-# contains GtkObjects/GObjects and you want to document signals and properties.
-GTKDOC_CFLAGS =                                        \
-       $(CFLAGS)                               \
-       $(CPPFLAGS)                             \
-       $(PANEL_CFLAGS)                         \
-       -I$(srcdir)/../../../libpanel-applet    \
-       -I$(top_builddir)/libpanel-applet
-
-GTKDOC_LIBS =                                          \
-       $(LDFLAGS)                                      \
-       $(PANEL_LIBS)                                   \
-       ../../../libpanel-applet/libpanel-applet.la
-
+       version.xml \
+       $(NULL)
+
+# Files where gtk-doc abbrevations (#GtkWidget) are expanded
+# e.g. expand_content_files=running.xml
+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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS = \
+       -I$(top_srcdir)/libpanel-applet \
+       -I$(top_builddir)/libpanel-applet \
+       $(PANEL_CFLAGS) \
+       $(NULL)
+
+GTKDOC_LIBS = \
+       $(top_builddir)/libpanel-applet/libpanel-applet.la \
+       $(PANEL_LIBS) \
+       $(NULL)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
-dist-hook-local:
-#      mkdir $(distdir)/TEXT;          \
-#      for f in $(srcdir)/TEXT/* ; do  \
-#        test -f $$f && cp -p $$f $(distdir)/TEXT; \
-#      done
-
 EXTRA_DIST += \
-       version.xml.in
+       version.xml.in \
+       $(NULL)
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = \
+  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+TESTS = $(GTKDOC_CHECK)
+endif
 
 -include $(top_srcdir)/git.mk