cairo/doc/public
Chris Wilson e90073f7dd [test] Build test suite into single binary.
Avoid calling libtool to link every single test case, by building just one
binary from all the sources.

This binary is then given the task of choosing tests to run (based on user
selection and individual test requirement), forking each test into its own
process and accumulating the results.
2008-10-31 12:30:11 +00:00
..
tmpl [test] Build test suite into single binary. 2008-10-31 12:30:11 +00: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 [check-*.sh] Redirect error reports to stderr 2008-09-26 11:08:22 -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] Add links to solid pattern constructors. 2008-09-30 11:47:53 +01:00
Makefile.am Fix scrambled version number in generated documentation. 2008-10-06 14:02:19 -07: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