mirror of
https://github.com/brl/mutter.git
synced 2024-12-04 13:50:41 -05:00
5f0a57ffdb
This adds a documentation section for CoglSnippet which gives an overview of how to use them. It also fixes some syntax errors in the existing documentation and adds the missing pipeline functions for adding snippets to the documentation sections file. Reviewed-by: Robert Bragg <robert@linux.intel.com>
160 lines
4.9 KiB
Makefile
160 lines
4.9 KiB
Makefile
## Process this file with automake to produce Makefile.in
|
|
|
|
# We require automake 1.6 at least.
|
|
AUTOMAKE_OPTIONS = 1.6
|
|
|
|
# This is a blank Makefile.am for using gtk-doc.
|
|
# Copy this to your project's API docs directory and modify the variables to
|
|
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
|
|
# of using the various options.
|
|
|
|
# The name of the module, e.g. 'glib'.
|
|
DOC_MODULE=cogl-2.0-experimental
|
|
|
|
# The top-level SGML file. You can change this if you want to.
|
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
|
|
|
|
# The directory containing the source code. Relative to $(srcdir).
|
|
# gtk-doc will search all .c & .h files beneath here for inline comments
|
|
# documenting the functions and macros.
|
|
# e.g. DOC_SOURCE_DIR=../../../gtk
|
|
DOC_SOURCE_DIR=../../../cogl
|
|
|
|
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
|
|
SCANGOBJ_OPTIONS=--type-init-func="g_type_init()"
|
|
|
|
# Extra options to supply to gtkdoc-scan.
|
|
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
|
|
SCAN_OPTIONS=--deprecated-guards="COGL_DISABLE_DEPRECATED"
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
|
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
|
|
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=cogl
|
|
|
|
# Extra options to supply to gtkdoc-mktmpl
|
|
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
|
|
MKTMPL_OPTIONS=
|
|
|
|
# Extra options to supply to gtkdoc-fixref. Not normally needed.
|
|
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
|
|
FIXXREF_OPTIONS=\
|
|
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
|
|
--extra-dir=$(GDPIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf
|
|
|
|
# Used for dependencies. The docs will be rebuilt if any of these change.
|
|
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
|
|
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
|
|
HFILE_GLOB=\
|
|
$(top_srcdir)/cogl/*.h \
|
|
$(top_builddir)/cogl/*.h \
|
|
$(top_srcdir)/cogl/winsys/*.h
|
|
CFILE_GLOB=$(top_srcdir)/cogl/*.c
|
|
|
|
# Header files to ignore when scanning.
|
|
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
|
|
IGNORE_HFILES=\
|
|
cogl-atlas.h \
|
|
cogl-atlas-texture-private.h \
|
|
cogl-bitmap-private.h \
|
|
cogl-buffer-private.h \
|
|
cogl-color-private.h \
|
|
cogl-feature-private.h \
|
|
cogl-framebuffer-private.h \
|
|
cogl-onscreen-private.h \
|
|
cogl-gtype-private.h \
|
|
cogl-index-array-private.h \
|
|
cogl-indices-private.h \
|
|
cogl-journal-private.h \
|
|
cogl-material-compat.h \
|
|
cogl-matrix-private.h \
|
|
cogl-object-private.h \
|
|
cogl-path.h \
|
|
cogl-path-private.h \
|
|
cogl-depth-state-private.h \
|
|
cogl-pipeline-fragend-arbfp-private.h \
|
|
cogl-pipeline-fragend-fixed-private.h \
|
|
cogl-pipeline-fragend-glsl-private.h \
|
|
cogl-pipeline-opengl-private.h \
|
|
cogl-pipeline-private.h \
|
|
cogl-pipeline-state-private.h \
|
|
cogl-pipeline-layer-state-private.h \
|
|
cogl-pipeline-progend-glsl-private.h \
|
|
cogl-pipeline-vertend-fixed-private.h \
|
|
cogl-pipeline-vertend-glsl-private.h \
|
|
cogl-pixel-array-private.h \
|
|
cogl-primitive-private.h \
|
|
cogl-primitives-private.h \
|
|
cogl-private.h \
|
|
cogl-program-private.h \
|
|
cogl-program.h \
|
|
cogl-shader-private.h \
|
|
cogl-shader.h \
|
|
cogl-snippet-private.h \
|
|
cogl-sub-texture-private.h \
|
|
cogl-texture-2d-private.h \
|
|
cogl-texture-2d-sliced-private.h \
|
|
cogl-texture-3d-private.h \
|
|
cogl-texture-private.h \
|
|
cogl-texture-rectangle-private.h \
|
|
cogl-vertex-buffer.h \
|
|
cogl-vertex-array-private.h \
|
|
cogl-vertex-attribute-private.h \
|
|
cogl-vertex-buffer-private.h \
|
|
cogl-blend-string.h \
|
|
cogl-clip-stack.h \
|
|
cogl-debug.h \
|
|
cogl-defines.h \
|
|
cogl-deprecated.h \
|
|
cogl-handle.h \
|
|
cogl-internal.h \
|
|
cogl-matrix-mesa.h \
|
|
cogl-matrix-stack.h \
|
|
cogl-spans.h \
|
|
cogl-profile.h \
|
|
cogl-util.h \
|
|
driver \
|
|
tesselator
|
|
|
|
EXTRA_HFILES=
|
|
|
|
# Images to copy into HTML directory.
|
|
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
|
|
HTML_IMAGES = \
|
|
fill-rule-non-zero.png \
|
|
fill-rule-even-odd.png \
|
|
quad-indices-order.png \
|
|
quad-indices-triangles.png \
|
|
cogl_ortho.png
|
|
|
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
|
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
|
|
content_files = \
|
|
blend-strings.xml
|
|
|
|
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
|
# These files must be listed here *and* in content_files
|
|
# e.g. expand_content_files=running.sgml
|
|
expand_content_files = \
|
|
blend-strings.xml
|
|
|
|
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
|
|
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
|
|
# signals and properties.
|
|
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
|
|
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
|
|
|
|
INCLUDES=-I$(top_srcdir) -I$(top_builddir)/cogl -DCOGL_ENABLE_EXPERIMENTAL_API $(COGL_DEP_CFLAGS)
|
|
GTKDOC_LIBS=$(top_builddir)/cogl/libcogl.la $(COGL_DEP_LIBS)
|
|
|
|
# This includes the standard gtk-doc make rules, copied by gtkdocize.
|
|
if BUILD_GTK_DOC
|
|
include $(top_srcdir)/gtk-doc.make
|
|
else
|
|
EXTRA_DIST =
|
|
endif
|
|
|
|
# Other files to distribute
|
|
# e.g. EXTRA_DIST += version.xml.in
|
|
|
|
EXTRA_DIST += $(HTML_IMAGES) $(content_files)
|