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 # The top-level SGML file. You can change this if you want to.
15 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
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=../../../cogl
23 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
24 SCANGOBJ_OPTIONS=--type-init-func="g_type_init()"
26 # Extra options to supply to gtkdoc-scan.
27 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
28 SCAN_OPTIONS=--deprecated-guards="COGL_DISABLE_DEPRECATED"
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 --name-space=cogl
34 # Extra options to supply to gtkdoc-mktmpl
35 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
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
41 --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
42 --extra-dir=$(GDPIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf
44 # Used for dependencies. The docs will be rebuilt if any of these change.
45 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
46 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
48 $(top_srcdir)/cogl/*.h \
49 $(top_builddir)/cogl/*.h
50 CFILE_GLOB=$(top_srcdir)/cogl/*.c
52 # Header files to ignore when scanning.
53 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
56 cogl-atlas-texture-private.h \
57 cogl-bitmap-private.h \
58 cogl-buffer-private.h \
59 cogl-color-private.h \
60 cogl-feature-private.h \
61 cogl-framebuffer-private.h \
62 cogl-onscreen-private.h \
63 cogl-gtype-private.h \
64 cogl-index-buffer-private.h \
65 cogl-indices-private.h \
66 cogl-journal-private.h \
67 cogl-matrix-private.h \
68 cogl-object-private.h \
70 cogl-depth-state-private.h \
71 cogl-pipeline-fragend-arbfp-private.h \
72 cogl-pipeline-fragend-fixed-private.h \
73 cogl-pipeline-fragend-glsl-private.h \
74 cogl-pipeline-opengl-private.h \
75 cogl-pipeline-private.h \
76 cogl-pipeline-state-private.h \
77 cogl-pipeline-layer-state-private.h \
78 cogl-pipeline-progend-glsl-private.h \
79 cogl-pipeline-vertend-fixed-private.h \
80 cogl-pipeline-vertend-glsl-private.h \
81 cogl-pixel-buffer-private.h \
82 cogl-primitive-private.h \
83 cogl-primitives-private.h \
85 cogl-program-private.h \
86 cogl-shader-private.h \
87 cogl-sub-texture-private.h \
88 cogl-texture-2d-private.h \
89 cogl-texture-2d-sliced-private.h \
90 cogl-texture-3d-private.h \
91 cogl-texture-private.h \
92 cogl-texture-rectangle-private.h \
93 cogl-vertex-array-private.h \
94 cogl-vertex-attribute-private.h \
95 cogl-vertex-buffer-private.h \
104 cogl-matrix-stack.h \
114 # Images to copy into HTML directory.
115 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
117 fill-rule-non-zero.png \
118 fill-rule-even-odd.png \
119 quad-indices-order.png \
120 quad-indices-triangles.png \
123 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
124 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
128 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
129 # These files must be listed here *and* in content_files
130 # e.g. expand_content_files=running.sgml
131 expand_content_files = \
134 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
135 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
136 # signals and properties.
137 # e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
138 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
140 INCLUDES=-I$(top_srcdir) -I$(top_builddir)/cogl -DCOGL_ENABLE_EXPERIMENTAL_API $(COGL_DEP_CFLAGS)
141 GTKDOC_LIBS=$(top_builddir)/cogl/libcogl.la $(COGL_DEP_LIBS)
143 # This includes the standard gtk-doc make rules, copied by gtkdocize.
145 include $(top_srcdir)/gtk-doc.make
150 # Other files to distribute
151 # e.g. EXTRA_DIST += version.xml.in
153 EXTRA_DIST += $(HTML_IMAGES) $(content_files)