Statistics
| Revision:

root / trunk / docs / reference / Makefile.am @ 1846

History | View | Annotate | Download (4.3 KB)

1
## Process this file with automake to produce Makefile.in
2
.PHONY: test test-report perf-report full-report test-nonrecursive
3

                
4
# We require automake 1.6 at least.
5
AUTOMAKE_OPTIONS = 1.6
6

                
7
# This is a blank Makefile.am for using gtk-doc.
8
# Copy this to your project's API docs directory and modify the variables to
9
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
10
# of using the various options.
11

                
12
# The name of the module, e.g. 'glib'.
13
DOC_MODULE=NNTPGrab
14

                
15
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
16
#DOC_MODULE_VERSION=2
17

                
18

                
19
# The top-level SGML file. You can change this if you want to.
20
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
21

                
22
# Directories containing the source code, relative to $(srcdir).
23
# gtk-doc will search all .c and .h files beneath these paths
24
# for inline comments documenting functions and macros.
25
# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
26
DOC_SOURCE_DIR=../../base ../../nntpgrab_core ../../glue ../../gui_base ../../automation
27

                
28
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
29
SCANGOBJ_OPTIONS=
30

                
31
# Extra options to supply to gtkdoc-scan.
32
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
33
SCAN_OPTIONS=--rebuild-types
34

                
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
38

                
39
# Extra options to supply to gtkdoc-mktmpl
40
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
41
MKTMPL_OPTIONS=
42

                
43
# Extra options to supply to gtkdoc-mkhtml
44
MKHTML_OPTIONS=
45

                
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
48
FIXXREF_OPTIONS=
49

                
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)/nntpgrab_core/nntpgrab.h $(top_srcdir)/nntpgrab_core/nntpgrab_plugin.h $(top_srcdir)/base/nntpgrab_utils.h $(top_srcdir)/base/nntpgrab_types.h $(top_srcdir)/gui_base/nntpgrab_gui_base.h $(top_srcdir)/automation/nntpgrab_automation.h
54
CFILE_GLOB=$(top_srcdir)/nntpgrab_core/nntpgrab_core.c $(top_srcdir)/glue/glue.c $(top_srcdir)/automation/automation_auto_import.c
55

                
56
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
57
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
58
#EXTRA_HFILES=$(HFILE_GLOB)
59

                
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=   collection_alloc.h \
63
         configuration.h \
64
         decoder_thread.h \
65
         download_queue.h \
66
         download_thread.h \
67
         marshalers.h \
68
         nntpconnection_backend_gio.h \
69
         nntpconnection_backend_iface.h \
70
         nntpconnection_backend_native.h \
71
         nntpconnection.h \
72
         nntpconnection_utils.h \
73
         nntpgrab_internal.h \
74
         plugins.h \
75
         queue_rawfile.h \
76
         strptime.h
77

                
78
# Images to copy into HTML directory.
79
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
80
HTML_IMAGES=
81

                
82
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
83
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
84
content_files=version.xml
85

                
86
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
87
# These files must be listed here *and* in content_files
88
# e.g. expand_content_files=running.sgml
89
expand_content_files=
90

                
91
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
92
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
93
# signals and properties.
94
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
95
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
96
GTKDOC_CFLAGS=$(GLIB_CFLAGS)
97
GTKDOC_LIBS=$(GLIB_LIBS) $(top_builddir)/nntpgrab_core/libnntpgrab.la $(top_builddir)/glue/libnntpgrab_glue.la $(top_builddir)/automation/libnntpgrab_automation.la
98

                
99
# This includes the standard gtk-doc make rules, copied by gtkdocize.
100
include $(top_srcdir)/gtk-doc.make
101

                
102
# Other files to distribute
103
# e.g. EXTRA_DIST += version.xml.in
104
EXTRA_DIST += version.xml.in
105

                
106
# Files not to distribute
107
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
108
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
109
#DISTCLEANFILES +=
110

                
111
# Comment this out if you want your docs-status tested during 'make check'
112
if ENABLE_GTK_DOC
113
#TESTS_ENVIRONMENT = cd $(srcsrc) &&
114
#TESTS = $(GTKDOC_CHECK)
115
endif
116

                
117
-include $(top_srcdir)/git.mk