|
1 | | -## Process this file with automake to produce Makefile.in |
| 1 | +# -*- mode: makefile -*- |
| 2 | +# |
| 3 | +# Makefile.am - template makefile for gtk-doc module |
| 4 | +# Copyright (C) 2007-2017 Stefan Sauer |
| 5 | +# |
| 6 | +# This program is free software: you can redistribute it and/or modify |
| 7 | +# it under the terms of the GNU General Public License as published by |
| 8 | +# the Free Software Foundation, either version 3 of the License, or |
| 9 | +# (at your option) any later version. |
| 10 | +# |
| 11 | +# This program is distributed in the hope that it will be useful, |
| 12 | +# but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | +# GNU General Public License for more details. |
| 15 | +# |
| 16 | +# You should have received a copy of the GNU General Public License |
| 17 | +# along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 18 | +# |
| 19 | +# As a special exception, the above copyright owner gives unlimited |
| 20 | +# permission to copy, distribute and modify this Makefile.am template. |
| 21 | +# You need not follow the terms of the GNU General Public License when |
| 22 | +# using or distributing such Makefile.am files, even though portions of |
| 23 | +# the text of the Makefile.am appear in them. The GNU General Public |
| 24 | +# License (GPL) does govern all other use of the material that constitutes |
| 25 | +# the Makefile.am template. |
| 26 | + |
| 27 | +# This is a blank Makefile.am for using gtk-doc. |
| 28 | +# Copy this to your project's API docs directory and modify the variables to |
| 29 | +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples |
| 30 | +# of using the various options. |
2 | 31 |
|
3 | 32 | # The name of the module, e.g. 'glib'. |
4 | 33 | DOC_MODULE=libiptcdata |
5 | 34 |
|
6 | | -# The top-level SGML file. Change it if you want. |
7 | | -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml |
| 35 | +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. |
| 36 | +#DOC_MODULE_VERSION=2 |
| 37 | + |
| 38 | +# The top-level XML file. |
| 39 | +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml |
8 | 40 |
|
9 | | -# The directory containing the source code. Relative to $(srcdir). |
10 | | -# gtk-doc will search all .c & .h files beneath here for inline comments |
11 | | -# documenting functions and macros. |
| 41 | +# Directories containing the source code. |
| 42 | +# gtk-doc will search all .c and .h files beneath these paths |
| 43 | +# for inline comments documenting functions and macros. |
| 44 | +# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk |
12 | 45 | DOC_SOURCE_DIR=../../libiptcdata |
13 | 46 |
|
14 | | -# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj. |
15 | | -SCANOBJ_OPTIONS= |
| 47 | +# Extra options to pass to gtkdoc-scangobj. Normally not needed. |
| 48 | +SCANGOBJ_OPTIONS= |
16 | 49 |
|
17 | 50 | # Extra options to supply to gtkdoc-scan. |
| 51 | +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" |
18 | 52 | SCAN_OPTIONS= |
19 | 53 |
|
20 | | -# Extra options to supply to gtkdoc-mkdb. |
21 | | -MKDB_OPTIONS= --sgml-mode --output-format=xml |
| 54 | +# Extra options to supply to gtkdoc-mkdb |
| 55 | +# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml |
| 56 | +MKDB_OPTIONS=--xml-mode --output-format=xml |
22 | 57 |
|
23 | | -# Extra options to supply to gtkdoc-fixref. |
| 58 | +# Extra options to supply to gtkdoc-mkhtml |
| 59 | +MKHTML_OPTIONS= |
| 60 | + |
| 61 | +# Extra options to supply to gtkdoc-fixref. Normally not needed. |
| 62 | +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html |
24 | 63 | FIXXREF_OPTIONS= |
25 | 64 |
|
26 | | -# Used for dependencies. |
| 65 | +# Used for dependencies. The docs will be rebuilt if any of these change. |
| 66 | +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h |
| 67 | +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c |
27 | 68 | HFILE_GLOB= |
28 | 69 | CFILE_GLOB= |
29 | 70 |
|
30 | | -# Header files to ignore when scanning. |
31 | | -IGNORE_HFILES= i18n.h |
| 71 | +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR |
| 72 | +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h |
| 73 | +EXTRA_HFILES= |
| 74 | + |
| 75 | +# Header files or dirs to ignore when scanning. Use base file/dir names |
| 76 | +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code |
| 77 | +IGNORE_HFILES= |
32 | 78 |
|
33 | 79 | # Images to copy into HTML directory. |
34 | | -HTML_IMAGES = |
| 80 | +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png |
| 81 | +HTML_IMAGES= |
35 | 82 |
|
36 | | -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). |
37 | | -content_files = \ |
| 83 | +# Extra files that are included by $(DOC_MAIN_SGML_FILE). |
| 84 | +# e.g. content_files=running.xml building.xml changes-2.0.xml |
| 85 | +content_files= \ |
38 | 86 | version.xml \ |
39 | | - about.sgml \ |
40 | | - commandline.sgml \ |
41 | | - i18n.sgml \ |
42 | | - libjpeg.sgml \ |
43 | | - overview.sgml |
| 87 | + about.xml \ |
| 88 | + commandline.xml \ |
| 89 | + i18n.xml \ |
| 90 | + libjpeg.xml \ |
| 91 | + overview.xml |
44 | 92 |
|
| 93 | +# Files where gtk-doc abbrevations (#GtkWidget) are expanded |
| 94 | +# e.g. expand_content_files=running.xml |
| 95 | +expand_content_files= |
| 96 | + |
| 97 | +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. |
| 98 | +# Only needed if you are using gtkdoc-scangobj to dynamically query widget |
| 99 | +# signals and properties. |
| 100 | +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) |
| 101 | +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) |
| 102 | +GTKDOC_CFLAGS= |
| 103 | +GTKDOC_LIBS= |
| 104 | + |
| 105 | +# This includes the standard gtk-doc make rules, copied by gtkdocize. |
45 | 106 | include $(top_srcdir)/gtk-doc.make |
46 | 107 |
|
| 108 | +# Comment this out if you don't want 'make check' to test you doc status |
| 109 | +# and run some sanity checks |
| 110 | +if ENABLE_GTK_DOC |
| 111 | +TESTS_ENVIRONMENT = \ |
| 112 | + DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ |
| 113 | + SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) |
| 114 | +TESTS = $(GTKDOC_CHECK) |
| 115 | +endif |
| 116 | + |
47 | 117 | EXTRA_DIST += \ |
48 | 118 | version.xml.in |
| 119 | + |
| 120 | +-include $(top_srcdir)/git.mk |
0 commit comments