diff options
author | Will Thompson <will.thompson@collabora.co.uk> | 2011-08-31 17:12:59 +0100 |
---|---|---|
committer | Will Thompson <will.thompson@collabora.co.uk> | 2011-09-01 09:56:37 +0100 |
commit | e0bc7368527fa5d2509a251d33e4d5e3dcf6dc34 (patch) | |
tree | 8aabddbee3a67743ddba58e2b5cef8e6dfb143ac /doc | |
parent | 8fbf0cfbee2ff547ad1a9cc331ad07243cfb2fdd (diff) |
docs: sync Makefiles with tp-glib's
This shouldn't change any behaviour. It just adds some defaults and
comments from tp-glib's copy (which in turn are synced with the sample
file shipped by gtk-doc) to make diffing the two easier.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/reference/libmissioncontrol-server/Makefile.am | 40 | ||||
-rw-r--r-- | doc/reference/mission-control-plugins/Makefile.am | 35 |
2 files changed, 58 insertions, 17 deletions
diff --git a/doc/reference/libmissioncontrol-server/Makefile.am b/doc/reference/libmissioncontrol-server/Makefile.am index 75551cc2..cd2066d9 100644 --- a/doc/reference/libmissioncontrol-server/Makefile.am +++ b/doc/reference/libmissioncontrol-server/Makefile.am @@ -11,29 +11,40 @@ AUTOMAKE_OPTIONS = 1.6 # The name of the module, e.g. 'glib'. DOC_MODULE=libmissioncontrol-server +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + # 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 +# Directories containing the source code, relative to $(srcdir). +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk DOC_SOURCE_DIR=$(abs_top_srcdir)/src $(abs_top_builddir)/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" +# 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 +# e.g. MKDB_OPTIONS=--xml-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-mkhtml +MKHTML_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= +FIXXREF_OPTIONS= # Used for dependencies. The docs will be rebuilt if any of these change. # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h @@ -41,8 +52,12 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml HFILE_GLOB=$(top_srcdir)/src/*.h CFILE_GLOB=$(top_srcdir)/src/*.c -# Header files to ignore when scanning. -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +# 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= stamp-mcd-enum-types.h \ mcd-service-gen.h \ mcd-signals-marshal.h @@ -55,6 +70,11 @@ HTML_IMAGES= # 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= + # Undefine this so the scanner doesn't inherit the ultra-pedantic warnings used # for real code. AM_CFLAGS = @@ -84,4 +104,4 @@ include $(top_srcdir)/gtk-doc.make # Other files to distribute # e.g. EXTRA_DIST += version.xml.in -EXTRA_DIST += +#EXTRA_DIST += diff --git a/doc/reference/mission-control-plugins/Makefile.am b/doc/reference/mission-control-plugins/Makefile.am index af7ed011..d8ee8c50 100644 --- a/doc/reference/mission-control-plugins/Makefile.am +++ b/doc/reference/mission-control-plugins/Makefile.am @@ -1,5 +1,6 @@ ## Process this file with automake to produce Makefile.in +# We require automake 1.9 at least. AUTOMAKE_OPTIONS = 1.9 # This is a blank Makefile.am for using gtk-doc. @@ -10,13 +11,17 @@ AUTOMAKE_OPTIONS = 1.9 # The name of the module, e.g. 'glib'. DOC_MODULE=mission-control-plugins +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + # 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 +# Directories containing the source code, relative to $(srcdir). +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk DOC_SOURCE_DIR=$(abs_top_srcdir)/mission-control-plugins $(abs_top_builddir)/mission-control-plugins # Extra options to pass to gtkdoc-scangobj. Not normally needed. @@ -27,13 +32,16 @@ SCANGOBJ_OPTIONS= SCAN_OPTIONS=--rebuild-types --rebuild-sections # Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +# e.g. MKDB_OPTIONS=--xml-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-mkhtml +MKHTML_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= @@ -44,8 +52,12 @@ FIXXREF_OPTIONS= HFILE_GLOB=$(top_srcdir)/mission-control-plugins/*.h CFILE_GLOB=$(top_srcdir)/mission-control-plugins/*.c -# Header files to ignore when scanning. -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +# 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=implementation.h debug-internal.h # Images to copy into HTML directory. @@ -81,6 +93,15 @@ GTKDOC_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 += + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + clean-local: clean-mcp # we actually treat all of these as disposable, in this "book" |