cairo/doc/public
Bryce Harrington ae954ae3ea doc: Drop a couple quartz routines which distcheck claims don't exist
These routines actually do exist in the source code, and have proper
documentation, so I'm not sure why distcheck dislikes them, but it's
happier without these listed.

Signed-off-by: Bryce Harrington <b.harrington@samsung.com>
2014-03-13 15:12:58 -07:00
..
.gitignore gitignore: Ignore generated tmpl dir in public docs 2014-03-05 12:50:36 -08:00
cairo-docs.xml doc: add missing chapters 2012-04-16 21:55:18 +02:00
cairo-overrides.txt configure.in Makefile.am docs/Makefile.am docs/public/*: Add framework for doing docs via gtk-doc. 2005-01-27 11:35:25 +00:00
cairo-sections.txt doc: Drop a couple quartz routines which distcheck claims don't exist 2014-03-13 15:12:58 -07:00
cairo.types configure.in Makefile.am docs/Makefile.am docs/public/*: Add framework for doing docs via gtk-doc. 2005-01-27 11:35:25 +00:00
check-doc-coverage.sh typo 2012-04-16 22:11:36 +02:00
check-doc-syntax.sh Set LC_ALL=C instead of LANG=C 2009-09-16 15:50:34 -04:00
language-bindings.xml mesh: Rename cairo_pattern_mesh_* functions to cairo_mesh_pattern_* 2011-02-07 20:28:09 +01:00
Makefile.am gl: Remove GLEW from the build system and the source tree 2010-12-15 15:32:20 +00:00
README Revamp the build system. 2008-09-02 20:24:08 -04:00

Cairo Reference Documentation
=============================

The API documentation is generated using gtk-doc.


Building
--------

The documentation is not built by default.  To build it you need to
configure with gtk-doc enabled (--enable-gtk-doc), and run:

	make doc


Adding New API
--------------

When adding new symbols and macros to the public API, modify
cairo-section.txt and add new symbols to the right place.

When adding whole new features, you also need to modify cairo-docs.xml
and add a new file under tmpl/.  Beware that the files are tmpl/ are
both manually edited AND modified by gtk-doc, gathering documentation
stub from source files.


Tests
-----

There are some tests in this directory, ensuring proper documentation
syntax as well as checking that all public symbols are fully documented.

After adding any new API, just run:

	make check