cairo/doc/public
Carl Worth 1d896aa9d8 Actually remove cairo_has_show_text_glyphs
The release notes for 1.7.6 say that we had dropped this
function, but apparently we had only planned to do that
and didn't actually get around to it until now.

Thanks to the RELEASING insctructions which gave a diff
command that pointed out this problem.
2008-09-25 15:56:57 -07:00
..
tmpl Actually remove cairo_has_show_text_glyphs 2008-09-25 15:56:57 -07:00
.gitignore Update .gitignore files 2008-06-26 16:20:58 -04:00
cairo-docs.xml [doc] Clean up doc file names 2008-09-02 20:24:00 -04: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 Actually remove cairo_has_show_text_glyphs 2008-09-25 15:56:57 -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 [doc/public/check-doc-coverage.sh] Make doc building needed for the test faster 2008-09-18 15:33:10 -04:00
check-doc-syntax.sh Make check-*.sh scripts more portable (#16299) 2008-06-12 21:03:19 -04:00
language-bindings.xml [doc] Make section title capitalization more consistent 2007-04-18 18:28:43 -04:00
Makefile.am Rename Makefile.*.config to Makefile.*.features as they should not be modified 2008-09-22 17:34:36 -04: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