GTK-Doc is used to document C code. It is typically used to document the public API of libraries, such as GLib-based libraries, but it can also be used to document application code.
Note that GTK-Doc wasn't originally intended to be a general-purpose documentation tool, so it can be a bit awkward to setup and use. For a more general-purpose documentation tool you may want to look at Doxygen. However GTK-Doc has some special code to document the signals and properties of GTK widgets and GObject classes which other tools may not have.
From your source code comments GTK-Doc generates a DocBook XML document, which is then transformed into HTML and/or PDF.
The generated HTML documentation can be browsed in an ordinary web browser or by using the special Devhelp API browser.
To generate the api-index-*.html files, you need to use docbook-style-xsl
version 1.79.1, not the latest version.
See:
See the help/manual/ directory. You can read the manual with
Yelp:
$ yelp help/manual/C/index.docbook
Python 3 with these additional modules:
- For the tests: unittest, parameterized
- For mkhtml2 (experimental): anytree, lxml and pygments
- For fixxref: pygments
For XML output (recommended):
- The DocBook XML DTD.
- The DocBook XSL Stylesheets.
- libxml2 and libxslt.
For PDF output:
- The dblatex tool.
The Meson build system is used.