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 will find all information about the syntax of the comments.
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.
The scanner can handle the majority of C headers fine. In the case of receiving warnings from the scanner that look like a special case, one can hint GTK-Doc to skip over them.
#ifndef __GTK_DOC_IGNORE__ /* unparseable code here */ #endif
Note, that GTK-Doc's supports #ifndef(__GTK_DOC_IGNORE__) but not #if !defined(__GTK_DOC_IGNORE__) or other combinations.
- 3.1. Documentation comments
- 3.2. Documenting sections
- 3.3. Documenting symbols
- 3.4. Inline program documentation
- 3.5. Useful DocBook tags