diff options
Diffstat (limited to 'libs/cairo-1.16.0/doc/public/README')
| -rw-r--r-- | libs/cairo-1.16.0/doc/public/README | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/libs/cairo-1.16.0/doc/public/README b/libs/cairo-1.16.0/doc/public/README deleted file mode 100644 index f3d157b..0000000 --- a/libs/cairo-1.16.0/doc/public/README +++ /dev/null @@ -1,37 +0,0 @@ -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 - |