cairo

mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2025-12-27 19:50:11 +01:00

History

Emmanuele Bassi aa09e2bedc docs: Use the proper xinclude path The XML files are moved in the xml directory.		2023-09-23 15:18:32 +01:00
..
.gitignore	gitignore: Ignore .trs (test results)	2015-07-31 17:56:54 -07:00
cairo-docs.xml	docs: Use the proper xinclude path	2023-09-23 15:18:32 +01:00
cairo-overrides.txt	docs: Add override for feature symbols	2023-08-13 16:41:20 +01:00
cairo-sections.txt	docs: Update the symbols list	2023-09-23 12:54:24 +01: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	doc: remove out of date remarks	2023-02-07 21:10:28 +10:30
meson.build	Remove unused _cairo_tee_surface_find_match	2023-02-05 16:15:25 +01:00
README	Revamp the build system.	2008-09-02 20:24:08 -04:00
version.xml.in	meson: Build the API reference	2021-08-14 15:34:23 +01: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