GTK-Doc Manual
-
1. Introduction
- 1.1. What is GTK-Doc?
- 1.2. How Does GTK-Doc Work?
- 1.3. Getting GTK-Doc
- 1.4. About GTK-Doc
- 1.5. About this Manual
-
2. Setting up your project
- 2.1. Setting up a skeleton documentation
- 2.2. Integration with autoconf
- 2.3. Integration with automake
- 2.4. Integration with autogen
- 2.5. Running the doc build
- 2.6. Integration with version control systems
- 2.7. Integration with plain makefiles or other build systems
- 2.8. Integration with CMake build systems
-
3. Documenting the code
- 3.1. Documentation comments
- 3.2. Documenting sections
- 3.3. Documenting symbols
- 3.4. Inline program documentation
- 3.5. Useful DocBook tags
- 4. Filling the extra files
-
5. Controlling the result
-
6. Modernizing the documentation
- 6.1. GTK-Doc 1.9
- 6.2. GTK-Doc 1.10
- 6.3. GTK-Doc 1.16
- 6.4. GTK-Doc 1.20
- 6.5. GTK-Doc 1.25
- 7. Documenting other interfaces
-
8. Frequently asked questions
-
9. Tools related to gtk-doc
-
A. GNU Free Documentation License
- A.1. 0. PREAMBLE
- A.2. 1. APPLICABILITY AND DEFINITIONS
- A.3. 2. VERBATIM COPYING
- A.4. 3. COPYING IN QUANTITY
- A.5. 4. MODIFICATIONS
- A.6. 5. COMBINING DOCUMENTS
- A.7. 6. COLLECTIONS OF DOCUMENTS
- A.8. 7. AGGREGATION WITH INDEPENDENT WORKS
- A.9. 8. TRANSLATION
- A.10. 9. TERMINATION
- A.11. 10. FUTURE REVISIONS OF THIS LICENSE
- A.12. Addendum