author | Mikael Hallendal <micke@imendio.com> |
Sun, 25 Feb 2007 00:05:31 +0100 | |
changeset 250 | e272ab792ccb |
parent 236 | b4e5c1cb114e |
child 398 | d81f80894575 |
child 555 | 695c909d0c45 |
permissions | -rw-r--r-- |
1 | 1 |
## Process this file with automake to produce Makefile.in |
2 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
3 |
# We require automake 1.6 at least. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
4 |
AUTOMAKE_OPTIONS = 1.6 |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
5 |
|
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
6 |
# This is a blank Makefile.am for using gtk-doc. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
7 |
# Copy this to your project's API docs directory and modify the variables to |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
8 |
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
9 |
# of using the various options. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
10 |
|
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
11 |
# The name of the module, e.g. 'glib'. |
1 | 12 |
DOC_MODULE=loudmouth |
13 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
14 |
# The top-level SGML file. You can change this if you want to. |
1 | 15 |
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml |
16 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
17 |
# The directory containing the source code. Relative to $(srcdir). |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
18 |
# gtk-doc will search all .c & .h files beneath here for inline comments |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
19 |
# documenting the functions and macros. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
20 |
# e.g. DOC_SOURCE_DIR=../../../gtk |
1 | 21 |
DOC_SOURCE_DIR=../../loudmouth |
22 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
23 |
# Extra options to pass to gtkdoc-scangobj. Not normally needed. |
1 | 24 |
SCANGOBJ_OPTIONS= |
25 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
26 |
# Extra options to supply to gtkdoc-scan. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
27 |
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
28 |
SCAN_OPTIONS= |
1 | 29 |
|
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
30 |
# Extra options to supply to gtkdoc-mkdb. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
31 |
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml |
1 | 32 |
MKDB_OPTIONS=--sgml-mode --output-format=xml |
33 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
34 |
# Extra options to supply to gtkdoc-mktmpl |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
35 |
# e.g. MKTMPL_OPTIONS=--only-section-tmpl |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
36 |
MKTMPL_OPTIONS= |
1 | 37 |
|
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
38 |
# Extra options to supply to gtkdoc-fixref. Not normally needed. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
39 |
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
40 |
FIXXREF_OPTIONS= |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
41 |
|
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
42 |
# Used for dependencies. The docs will be rebuilt if any of these change. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
43 |
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
44 |
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c |
1 | 45 |
HFILE_GLOB=$(top_srcdir)/loudmouth/*.h |
46 |
CFILE_GLOB=$(top_srcdir)/loudmouth/*.c |
|
47 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
48 |
# Header files to ignore when scanning. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
49 |
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h |
250
e272ab792ccb
Added more h-files to the docs ignore list
Mikael Hallendal <micke@imendio.com>
parents:
236
diff
changeset
|
50 |
IGNORE_HFILES=base64.h md5.h lm-internals.h lm-sha.h lm-parser.h lm-sock.h lm-socket.h lm-message-queue.h lm-ssl-base.h lm-ssl-internals.h loudmouth.h lm-sasl.h lm-misc.h |
1 | 51 |
|
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
52 |
# Images to copy into HTML directory. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
53 |
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
54 |
HTML_IMAGES= |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
55 |
|
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
56 |
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
57 |
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
58 |
content_files= |
1 | 59 |
|
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
60 |
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
61 |
# These files must be listed here *and* in content_files |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
62 |
# e.g. expand_content_files=running.sgml |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
63 |
expand_content_files= |
1 | 64 |
|
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
65 |
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
66 |
# Only needed if you are using gtkdoc-scangobj to dynamically query widget |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
67 |
# signals and properties. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
68 |
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
69 |
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
70 |
INCLUDES= \ |
1 | 71 |
$(LOUDMOUTH_CFLAGS) \ |
72 |
-DLM_COMPILATION \ |
|
73 |
-I$(top_srcdir) \ |
|
74 |
-I$(top_builddir)/loudmouth |
|
75 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
76 |
GTKDOC_LIBS= \ |
1 | 77 |
$(LOUDMOUTH_LIBS) \ |
78 |
$(top_builddir)/loudmouth/libloudmouth.la |
|
79 |
||
80 |
||
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
81 |
# This includes the standard gtk-doc make rules, copied by gtkdocize. |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
82 |
include $(top_srcdir)/gtk-doc.make |
1 | 83 |
|
141
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
84 |
# Other files to distribute |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
85 |
# e.g. EXTRA_DIST += version.xml.in |
f918e888a0aa
2006-04-19 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents:
1
diff
changeset
|
86 |
EXTRA_DIST += |