fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-01-01 07:10:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
cairo/doc/public
History
Behdad Esfahbod b7a838261b Move m4 macros into build/aclocal.*.m4 files
2008-09-11 04:17:43 -04:00
..
tmpl Move m4 macros into build/aclocal.*.m4 files 2008-09-11 04:17:43 -04: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 Add support for always-builtin features in the build system 2008-09-11 00:38:30 -04: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] Also test cairo-undeclared 2008-09-03 20:52:17 -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 [doc] Don't include *.h as sources 2008-09-11 00:38:29 -04:00
README Revamp the build system. 2008-09-02 20:24:08 -04:00
version.xml.in Add an autoconf-generated version file to advertise what cairo version the manual was generated for. Idea taken from the GTK+ documentation. 2005-08-18 08:28:08 +00:00

README 

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