Add rudimentary gtk-doc support to the project
[profile/ivi/node-startup-controller.git] / docs / reference / node-startup-controller / Makefile.am
1 # vi:set ts=8 sw=8 noet ai nocindent:
2
3 # We require automake 1.6 at least.
4 AUTOMAKE_OPTIONS = 1.6
5
6 # The name of the module, e.g. 'glib'.
7 DOC_MODULE='node-startup-controller'
8
9 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
10 DOC_MODULE_VERSION=$(BOOT_MANAGER_VERSION)
11
12 # The top-level SGML file. You can change this if you want to.
13 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
14
15 # Directories containing the source code.
16 # gtk-doc will search all .c and .h files beneath these paths
17 # for inline comments documenting functions and macros.
18 # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
19 DOC_SOURCE_DIR=$(top_builddir)/boot-manager
20
21 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
22 SCANGOBJ_OPTIONS=
23
24 # Extra options to supply to gtkdoc-scan.
25 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
26 SCAN_OPTIONS=
27
28 # Extra options to supply to gtkdoc-mkdb.
29 # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
30 MKDB_OPTIONS=--xml-mode --output-format=xml
31
32 # Extra options to supply to gtkdoc-mktmpl
33 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
34 MKTMPL_OPTIONS=
35
36 # Extra options to supply to gtkdoc-mkhtml
37 MKHTML_OPTIONS=
38
39 # Extra options to supply to gtkdoc-fixref. Not normally needed.
40 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
41 FIXXREF_OPTIONS=
42
43 # Used for dependencies. The docs will be rebuilt if any of these change.
44 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
45 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
46 HFILE_GLOB=
47 CFILE_GLOB=
48
49 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
50 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
51 EXTRA_HFILES=
52
53 # Header files or dirs to ignore when scanning. Use base file/dir names
54 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
55 IGNORE_HFILES=
56
57 # Images to copy into HTML directory.
58 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
59 HTML_IMAGES=
60
61 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
62 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
63 content_files=
64
65 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
66 # These files must be listed here *and* in content_files
67 # e.g. expand_content_files=running.sgml
68 expand_content_files=
69
70 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
71 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
72 # signals and properties.
73 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
74 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
75 GTKDOC_CFLAGS=
76 GTKDOC_LIBS=
77
78 # This includes the standard gtk-doc make rules, copied by gtkdocize.
79 include $(top_srcdir)/gtk-doc.make
80
81 # Other files to distribute
82 # e.g. EXTRA_DIST += version.xml.in
83 EXTRA_DIST +=
84
85 # Files not to distribute
86 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
87 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
88 #DISTCLEANFILES +=
89
90 # Comment this out if you want 'make check' to test you doc status
91 # and run some sanity checks
92 if ENABLE_GTK_DOC
93 TESTS_ENVIRONMENT = cd $(srcdir) && \
94   DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
95   SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
96 #TESTS = $(GTKDOC_CHECK)
97 endif
98
99 -include $(top_srcdir)/git.mk