mirror of
https://gitlab.freedesktop.org/cairo/cairo.git
synced 2026-02-15 08:00:34 +01:00
7f114b781f
This looks to be an ugly necessity to work-around the nasty issue that we currently gtkdoc expect to be run inside the source tree. I'm sure Behdad will be able to resolve this much more elegantly than this quick and fragile attempt. |
||
|---|---|---|
| .. | ||
| tmpl | ||
| .gitignore | ||
| cairo-docs.xml | ||
| cairo-overrides.txt | ||
| cairo-sections.txt | ||
| cairo.types | ||
| check-doc-coverage.sh | ||
| check-doc-syntax.sh | ||
| language-bindings.xml | ||
| Makefile.am | ||
| 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