* add documentation
[modest] / docs / reference / Makefile.am
1 ## Process this file with automake to produce Makefile.in
2
3 # This is a blank Makefile.am for using gtk-doc.
4 # Copy this to your project's API docs directory and modify the variables to
5 # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
6 # of using the various options.
7
8 # The name of the module, e.g. 'glib'.
9 DOC_MODULE=modest
10
11 # The top-level SGML file. You can change this if you want to.
12 DOC_MAIN_SGML_FILE=modest-docs.sgml
13
14 # The directory containing the source code. Relative to $(srcdir).
15 # gtk-doc will search all .c & .h files beneath here for inline comments
16 # documenting the functions and macros.
17 # e.g. DOC_SOURCE_DIR=../../../gtk
18 DOC_SOURCE_DIR=$(top_srcdir)/src
19
20 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
21 SCANGOBJ_OPTIONS=
22
23 # Extra options to supply to gtkdoc-scan.
24 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
25 SCAN_OPTIONS=
26
27 # Extra options to supply to gtkdoc-mkdb.
28 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
29 MKDB_OPTIONS=--sgml-mode --output-format=xml
30
31 # Extra options to supply to gtkdoc-mktmpl
32 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
33 MKTMPL_OPTIONS=
34
35 # Extra options to supply to gtkdoc-fixref. Not normally needed.
36 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
37 FIXXREF_OPTIONS=
38
39 # Used for dependencies. The docs will be rebuilt if any of these change.
40 # e.g. HFILE_GLOB=$(top_srcdir)/*.h
41 # e.g. CFILE_GLOB=$(top_srcdir)/*.c
42 HFILE_GLOB=$(top_srcdir)/src/*.h 
43 CFILE_GLOB=$(top_srcdir)/src/*.c 
44
45 # Header files to ignore when scanning.
46 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
47 IGNORE_HFILES=
48
49 # Images to copy into HTML directory.
50 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
51 HTML_IMAGES=
52
53 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
54 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
55 content_files=#xml/tree_index.sgml
56
57 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
58 # These files must be listed here *and* in content_files
59 # e.g. expand_content_files=running.sgml
60 expand_content_files=
61
62 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
63 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
64 # signals and properties.
65 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
66 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
67 INCLUDES=-I$(top_srcdir)/src $(MODEST_GSTUFF_CFLAGS)
68 GTKDOC_LIBS=$(MODEST_GSTUFF_LIBS)
69
70 # This includes the standard gtk-doc make rules, copied by gtkdocize.
71 include $(top_srcdir)/gtk-doc.make
72
73 # Other files to distribute
74 # e.g. EXTRA_DIST += version.xml.in
75 EXTRA_DIST +=