0e0ef6b79f88eaba0d605abe5edd3d4c9a62cef8
[WebKit-https.git] / Source / WebKit / gtk / docs / GNUmakefile.am
1 ## Process this file with automake to produce GNUmakefile.in
2
3 # We require automake 1.6 at least.
4 AUTOMAKE_OPTIONS = 1.6
5
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.
10
11 # The name of the module, e.g. 'glib'.
12 DOC_MODULE=webkitgtk
13
14 # The top-level SGML file. You can change this if you want to.
15 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
16
17 # The directory containing the source code. Relative to $(srcdir).
18 # gtk-doc will search all .c & .h files beneath here for inline comments
19 # documenting the functions and macros.
20 # e.g. DOC_SOURCE_DIR=../../../gtk
21 DOC_SOURCE_DIR=$(top_srcdir)/Source/WebKit/gtk/webkit
22
23 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
24 SCANGOBJ_OPTIONS="--type-init-func=g_thread_init(NULL);g_type_init()"
25
26 # Extra options to supply to gtkdoc-scan.
27 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
28 SCAN_OPTIONS=--deprecated-guards="WEBKIT_DISABLE_DEPRECATED" --ignore-decorators="WEBKIT_API"
29
30 # Extra options to supply to gtkdoc-mkdb.
31 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
32 MKDB_OPTIONS=--sgml-mode --output-format=xml --source-suffixes=h,c,cpp
33
34 # Extra options to supply to gtkdoc-mktmpl
35 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
36 MKTMPL_OPTIONS=
37
38 # Extra options to supply to gtkdoc-fixref. Not normally needed.
39 # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
40 FIXXREF_OPTIONS=
41
42 # Used for dependencies. The docs will be rebuilt if any of these change.
43 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
44 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
45 HFILE_GLOB=$(top_srcdir)/Source/WebKit/gtk/webkit/*.h
46 CFILE_GLOB=$(top_srcdir)/Source/WebKit/gtk/webkit/*.cpp
47
48 # Header files to ignore when scanning.
49 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
50 IGNORE_HFILES = \
51    webkitdownloadprivate.h \
52    webkitgeolocationpolicydecisionprivate.h \
53    webkitglobalsprivate.h \
54    webkithittestresultprivate.h \
55    webkitnetworkrequestprivate.h \
56    webkitnetworkresponseprivate.h \
57    webkitsecurityoriginprivate.h \
58    webkitviewportattributesprivate.h \
59    webkitwebbackforwardlistprivate.h \
60    webkitwebdatasourceprivate.h \
61    webkitwebframeprivate.h \
62    webkitwebhistoryitemprivate.h \
63    webkitwebinspectorprivate.h \
64    webkitwebnavigationactionprivate.h \
65    webkitwebplugindatabaseprivate.h \
66    webkitwebpluginprivate.h \
67    webkitwebpolicydecisionprivate.h \
68    webkitwebresourceprivate.h \
69    webkitwebsettingsprivate.h \
70    webkitwebviewprivate.h \
71    webkitwebwindowfeaturesprivate.h
72
73 # Images to copy into HTML directory.
74 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
75 HTML_IMAGES=
76
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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
81 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
82 INCLUDES= \
83         -I$(abs_srcdir)/Source/WebKit/gtk \
84         -I$(abs_builddir)/Source/WebKit/gtk \
85         $(global_cppflags) \
86         $(global_cflags) \
87         -I$(abs_srcdir)/Source \
88         -I$(abs_srcdir)/Source/JavaScriptCore \
89         -I$(abs_srcdir)/Source/JavaScriptCore/ForwardingHeaders \
90         -I$(abs_srcdir)/Source/JavaScriptCore/parser \
91         -I$(abs_srcdir)/Source/JavaScriptCore/wtf \
92         -I$(abs_builddir)/DerivedSources \
93         -I$(abs_srcdir)/Source/WebCore/platform/network/soup/cache \
94         $(GLOBALDEPS_CFLAGS) \
95         $(CAIRO_CFLAGS) \
96         $(GLIB_CFLAGS) \
97         $(GTK_CFLAGS) \
98         $(LIBSOUP_CFLAGS)
99 GTKDOC_LIBS= \
100         $(abs_builddir)/libjavascriptcoregtk-@WEBKITGTK_API_MAJOR_VERSION@.@WEBKITGTK_API_MINOR_VERSION@.la \
101         $(abs_builddir)/libwebkitgtk-@WEBKITGTK_API_MAJOR_VERSION@.@WEBKITGTK_API_MINOR_VERSION@.la \
102         $(GLIB_LIBS) \
103         $(GTK_LIBS) \
104         $(LIBSOUP_LIBS)
105
106 # This includes our custom gtk-doc make rules.
107 include $(top_srcdir)/Source/WebKit/gtk/GNUmakefile.gtk-doc.am
108
109 # Other files to distribute
110 # e.g. EXTRA_DIST += version.xml.in
111 EXTRA_DIST += \
112         $(WebKit)/docs/webkitenvironment.xml \
113         $(WebKit)/docs/webkitgtk-docs.sgml \
114         $(WebKit)/docs/webkitgtk-sections.txt \
115         $(WebKit)/docs/version.xml.in
116
117 # Files not to distribute
118 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
119 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
120 DISTCLEANFILES += \
121         $(top_builddir)/Source/WebKit/gtk/docs/version.xml
122
123 # Comment this out if you want your docs-status tested during 'make check'
124 #TESTS = $(GTKDOC_CHECK)
125