fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-01-07 13:40:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
cairo/doc/public
History
Adrian Johnson 0ce4c0fc29 Add cairo_pdf_surface_set_custom_metadata()
2021-08-22 13:43:34 +09:30
..
.gitignore gitignore: Ignore .trs (test results) 2015-07-31 17:56:54 -07:00
cairo-docs.xml 1.16.0 release 2018-10-19 13:23:16 -07: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 cairo_pdf_surface_set_custom_metadata() 2021-08-22 13:43:34 +09: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 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 mesh: Rename cairo_pattern_mesh_* functions to cairo_mesh_pattern_* 2011-02-07 20:28:09 +01:00
Makefile.am Retire dummy cairo-version.h header to fix meson subproject build 2020-09-29 15:50:53 +00:00
meson.build meson: Build the API reference 2021-08-14 15:34:23 +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