fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2025-12-27 14:00:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
cairo/doc/public
History
Adrian Johnson 1869e0240b Document cairo_surface_(set|get)_mime_data() and mime types
2008-12-23 15:04:06 +10:30
..
tmpl Document cairo_surface_(set|get)_mime_data() and mime types 2008-12-23 15:04:06 +10:30
.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 Document cairo_surface_(set|get)_mime_data() and mime types 2008-12-23 15:04:06 +10:30
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

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