brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c328e0608f
mutter/doc/reference/cogl/Makefile.am

153 lines
4.7 KiB
Makefile
Raw Normal View History

Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
## 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
# The top-level SGML file. You can change this if you want to.
[docs] Rename cogl-docs from sgml to xml The cogl-docs.sgml file has always been XML, so it's only fitting that we actually call it cogl-docs.xml.
2009-02-20 07:01:32 -05:00
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# 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
build: Enable building the documentation again At least the 1.6.0 documentation. The 2.0 one has been missed by the filter-branch and will be re-added later.
2011-05-06 12:59:00 -04:00
DOC_SOURCE_DIR=../../../cogl
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# Extra options to pass to gtkdoc-scangobj. Not normally needed.
[docs] Update build for COGL API reference We need to initialize the type system for gtk-doc-scan, now that COGL exposes GTypes.
2009-02-19 12:06:25 -05:00
SCANGOBJ_OPTIONS=--type-init-func="g_type_init()"
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# Extra options to supply to gtkdoc-scan.
[cogl-material] Support string based blending and layer combine descriptions Setting up layer combine functions and blend modes is very awkward to do programatically. This adds a parser for string based descriptions which are more consise and readable. E.g. a material layer combine function could now be given as: "RGBA = ADD (TEXTURE[A], PREVIOUS[RGB])" or "RGB = REPLACE (PREVIOUS)" "A = MODULATE (PREVIOUS, TEXTURE)" The simple syntax and grammar are only designed to expose standard fixed function hardware, more advanced combining must be done with shaders. This includes standalone documentation of blend strings covering the aspects that are common to blending and texture combining, and adds documentation with examples specific to the new cogl_material_set_blend() and cogl_material_layer_set_combine() functions. Note: The hope is to remove the now redundant bits of the material API before 1.0
2009-05-10 19:40:41 -04:00
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
[docs] Update build for COGL API reference We need to initialize the type system for gtk-doc-scan, now that COGL exposes GTypes.
2009-02-19 12:06:25 -05:00
SCAN_OPTIONS=--deprecated-guards="COGL_DISABLE_DEPRECATED"
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
[docs] Use the --name-space option Now that we depend on gtk-doc 1.11 we can use the --name-space command line option for the mkdb utility.
2009-02-20 06:58:04 -05:00
MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=cogl
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# 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 \
docs: Various fixes for gtk-doc
2010-06-30 10:50:47 -04:00
--extra-dir=$(GDPIXBUF_PREFIX)/share/gtk-doc/html/gdk-pixbuf
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# 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=\
build: Enable building the documentation again At least the 1.6.0 documentation. The 2.0 one has been missed by the filter-branch and will be re-added later.
2011-05-06 12:59:00 -04:00
$(top_srcdir)/cogl/*.h \
$(top_builddir)/cogl/*.h
CFILE_GLOB=$(top_srcdir)/cogl/*.c
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=\
docs: Fixes for Cogl
2010-02-12 10:52:07 -05:00
cogl-atlas.h \
docs: Fix up the Cogl API reference build
2010-09-03 12:15:22 -04:00
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 \
build: Ignore private headers when building the Cogl reference Otherwise gtk-doc will try to look up private symbols.
2010-12-21 07:03:38 -05:00
cogl-gtype-private.h \
cogl-index-array-private.h \
cogl-indices-private.h \
docs: Fix up the Cogl API reference build
2010-09-03 12:15:22 -04:00
cogl-journal-private.h \
cogl-matrix-private.h \
cogl-object-private.h \
cogl-path-private.h \
build: Ignore private headers when building the Cogl reference Otherwise gtk-doc will try to look up private symbols.
2010-12-21 07:03:38 -05:00
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-progend-glsl-private.h \
cogl-pipeline-vertend-fixed-private.h \
cogl-pipeline-vertend-glsl-private.h \
Rename CoglPixelArray to CoglPixelBuffer This is part of a broader cleanup of some of the experimental Cogl API. One of the reasons for this particular rename is to switch away from using the term "Array" which implies a regular, indexable layout which isn't the case. We also want to strongly imply a relationship between CoglBuffers and CoglPixelBuffers and be consistent with the CoglAttributeBuffer and CoglIndexBuffer APIs.
2011-03-02 10:19:57 -05:00
cogl-pixel-buffer-private.h \
build: Ignore private headers when building the Cogl reference Otherwise gtk-doc will try to look up private symbols.
2010-12-21 07:03:38 -05:00
cogl-primitive-private.h \
cogl-primitives-private.h \
cogl-private.h \
cogl-program-private.h \
docs: Fix up the Cogl API reference build
2010-09-03 12:15:22 -04:00
cogl-shader-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 \
build: Ignore private headers when building the Cogl reference Otherwise gtk-doc will try to look up private symbols.
2010-12-21 07:03:38 -05:00
cogl-vertex-array-private.h \
cogl-vertex-attribute-private.h \
docs: Fix up the Cogl API reference build
2010-09-03 12:15:22 -04:00
cogl-vertex-buffer-private.h \
docs: Clean up the unused symbols for Cogl Gtk-doc is reporting a lot of false positives in the unused text file, mostly because of new private files that have been added to Cogl but not to the gtk-doc ignore list for the Cogl API reference. Once the false positives have been removed we have a couple of really missing symbols that should be added to the cogl-sections.txt file.
2010-02-09 10:29:29 -05:00
cogl-blend-string.h \
cogl-clip-stack.h \
cogl-context.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 \
docs: Fixes for Cogl
2010-02-12 10:52:07 -05:00
cogl-profile.h \
docs: Clean up the unused symbols for Cogl Gtk-doc is reporting a lot of false positives in the unused text file, mostly because of new private files that have been added to Cogl but not to the gtk-doc ignore list for the Cogl API reference. Once the false positives have been removed we have a couple of really missing symbols that should be added to the cogl-sections.txt file.
2010-02-09 10:29:29 -05:00
cogl-util.h \
driver \
docs: Various fixes for gtk-doc
2010-06-30 10:50:47 -04:00
tesselator \
docs: Fix Cogl API reference build • Ignore all the private header files • Add all missing/unused symbols • Remove deprecated symbols from 0.*
2009-11-19 07:34:06 -05:00
winsys
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
EXTRA_HFILES=
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
cogl-path: Document how a shape is filled This adds some documentation to cogl_path_fill() describing the fill rule Cogl uses.
2010-04-21 06:49:57 -04:00
HTML_IMAGES = \
cogl-path: Allow changing the fill rule This adds two new API calls- cogl_path_set_fill_rule and cogl_path_get_fill_rule. This allows modifying the fill rule of the current path. In addition to the previous default fill rule of 'even-odd' it now supports the 'non-zero' rule. The fill rule is a property of the path (not the Cogl context) so creating a new path or preserving a path with cogl_path_get_handle affects the fill rule.
2010-06-23 08:40:43 -04:00
fill-rule-non-zero.png \
fill-rule-even-odd.png \
Convert the ASCII art documentation in cogl-vertex-buffer to PNGs The documentation for cogl_vertex_buffer_indices_get_for_quads was using ugly ASCII art to draw the diagrams. These have now been replaced with PNG figures.
2010-07-02 11:19:48 -04:00
quad-indices-order.png \
quad-indices-triangles.png \
cogl docs: Improve documentation for cogl_ortho cogl_ortho is one of those APIs whos style was, for better or worse, copied from OpenGL and for some inexplicable reason the near and far arguments are inconsistent with the left, right, top, bottom arguments because they don't take z coordinates they take a "distance" which should be negative for a plane behind the viewer. This updates the documentation to explain this.
2010-05-25 22:07:17 -04:00
cogl_ortho.png
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
[cogl-material] Support string based blending and layer combine descriptions Setting up layer combine functions and blend modes is very awkward to do programatically. This adds a parser for string based descriptions which are more consise and readable. E.g. a material layer combine function could now be given as: "RGBA = ADD (TEXTURE[A], PREVIOUS[RGB])" or "RGB = REPLACE (PREVIOUS)" "A = MODULATE (PREVIOUS, TEXTURE)" The simple syntax and grammar are only designed to expose standard fixed function hardware, more advanced combining must be done with shaders. This includes standalone documentation of blend strings covering the aspects that are common to blending and texture combining, and adds documentation with examples specific to the new cogl_material_set_blend() and cogl_material_layer_set_combine() functions. Note: The hope is to remove the now redundant bits of the material API before 1.0
2009-05-10 19:40:41 -04:00
content_files = \
blend-strings.xml
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# 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
[cogl-material] Support string based blending and layer combine descriptions Setting up layer combine functions and blend modes is very awkward to do programatically. This adds a parser for string based descriptions which are more consise and readable. E.g. a material layer combine function could now be given as: "RGBA = ADD (TEXTURE[A], PREVIOUS[RGB])" or "RGB = REPLACE (PREVIOUS)" "A = MODULATE (PREVIOUS, TEXTURE)" The simple syntax and grammar are only designed to expose standard fixed function hardware, more advanced combining must be done with shaders. This includes standalone documentation of blend strings covering the aspects that are common to blending and texture combining, and adds documentation with examples specific to the new cogl_material_set_blend() and cogl_material_layer_set_combine() functions. Note: The hope is to remove the now redundant bits of the material API before 1.0
2009-05-10 19:40:41 -04:00
expand_content_files = \
blend-strings.xml
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# 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)
build: Enable building the documentation again At least the 1.6.0 documentation. The 2.0 one has been missed by the filter-branch and will be re-added later.
2011-05-06 12:59:00 -04:00
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)
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# This includes the standard gtk-doc make rules, copied by gtkdocize.
build: Allow to compile a git checkout without gtk-doc Gtk-doc can be hard to install on Windows. This patch enables people wanting to hack on Cogl itself from a Windows system to do so without the hassle to get gtk-doc installed first.
2011-05-12 06:07:30 -04:00
EXTRA_DIST =
-include $(top_srcdir)/gtk-doc.make
Merged clutter-ivan branch into trunk. svn merge \ https://svn.o-hand.com/repos/clutter/trunk/clutter@2509 \ https://svn.o-hand.com/repos/clutter/branches/clutter-ivan@HEAD
2008-04-25 09:37:36 -04:00
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
cogl-path: Document how a shape is filled This adds some documentation to cogl_path_fill() describing the fill rule Cogl uses.
2010-04-21 06:49:57 -04:00
EXTRA_DIST += \
cogl-path: Allow changing the fill rule This adds two new API calls- cogl_path_set_fill_rule and cogl_path_get_fill_rule. This allows modifying the fill rule of the current path. In addition to the previous default fill rule of 'even-odd' it now supports the 'non-zero' rule. The fill rule is a property of the path (not the Cogl context) so creating a new path or preserving a path with cogl_path_get_handle affects the fill rule.
2010-06-23 08:40:43 -04:00
fill-rule-non-zero.png \
fill-rule-even-odd.png \
Convert the ASCII art documentation in cogl-vertex-buffer to PNGs The documentation for cogl_vertex_buffer_indices_get_for_quads was using ugly ASCII art to draw the diagrams. These have now been replaced with PNG figures.
2010-07-02 11:19:48 -04:00
quad-indices-triangles.png \
quad-indices-order.png \
cogl docs: Improve documentation for cogl_ortho cogl_ortho is one of those APIs whos style was, for better or worse, copied from OpenGL and for some inexplicable reason the near and far arguments are inconsistent with the left, right, top, bottom arguments because they don't take z coordinates they take a "distance" which should be negative for a plane behind the viewer. This updates the documentation to explain this.
2010-05-25 22:07:17 -04:00
cogl_ortho.png
Reference in New Issue Copy Permalink