1 ## Process this file with automake to produce Makefile.in
3 # We require automake 1.6 at least.
6 # This is a blank Makefile.am for using gtk-doc.
7 # Copy this to your project's API docs directory and modify the variables to
8 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
9 # of using the various options.
11 # The name of the module, e.g. 'glib'.
14 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
18 # The top-level SGML file. You can change this if you want to.
19 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
21 # Directories containing the source code, relative to $(srcdir).
22 # gtk-doc will search all .c and .h files beneath these paths
23 # for inline comments documenting functions and macros.
24 # e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
25 DOC_SOURCE_DIR=../../lib
27 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
30 # Extra options to supply to gtkdoc-scan.
31 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
32 SCAN_OPTIONS=--ignore-decorators=ASN1_API \
33 --deprecated-guards=ASN1_DISABLE_DEPRECATED
35 # Extra options to supply to gtkdoc-mkdb.
36 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
37 MKDB_OPTIONS=--sgml-mode --output-format=xml
39 # Extra options to supply to gtkdoc-mktmpl
40 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
43 # Extra options to supply to gtkdoc-mkhtml
46 # Extra options to supply to gtkdoc-fixref. Not normally needed.
47 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
50 # Used for dependencies. The docs will be rebuilt if any of these change.
51 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
52 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
53 HFILE_GLOB=$(top_srcdir)/lib/*.h
54 CFILE_GLOB=$(top_srcdir)/lib/*.c
56 # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
57 # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
60 # Header files to ignore when scanning. Use base file name, no paths
61 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
62 IGNORE_HFILES=int.h parser_aux.h structure.h element.h gstr.h gllib
64 # Images to copy into HTML directory.
65 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
68 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
69 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
72 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
73 # These files must be listed here *and* in content_files
74 # e.g. expand_content_files=running.sgml
77 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
78 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
79 # signals and properties.
80 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
81 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
85 # This includes the standard gtk-doc make rules, copied by gtkdocize.
86 include $(top_srcdir)/gtk-doc.make
88 # Other files to distribute
89 # e.g. EXTRA_DIST += version.xml.in
92 # Files not to distribute
93 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
94 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
97 # Comment this out if you want your docs-status tested during 'make check'
99 #TESTS_ENVIRONMENT = cd $(srcsrc) &&
100 #TESTS = $(GTKDOC_CHECK)