Documenting the code
GTK-Doc uses source code comment with a special syntax for code documentation. Further it retrieves information about your project structure from other sources. During the next section you find all information about the syntax of the comments.
Documentation placement
In the past most documentation had to be filled into files residing inside the tmpl directory. This has the disadvantages that the information is often not updated and also that the file tend to cause conflicts with version control systems.
The avoid the aforementioned problems we suggest putting the documentation inside the sources. This manual will only describe this way of documenting code.
- 3.1. Documentation comments
- 3.2. Documenting sections
- 3.3. Documenting symbols
- 3.4. Useful DocBook tags