blob: f3d157b1a93768c7fa1871ffbaeafdab48520d95 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
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
|
