编写代码文档

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.

文档位置

在过去,多数文档不得不写入驻留在tmpl目录的文件中。这样会出现一些糟糕的情况:其信息常常没有更新,而且文件也倾向于与版本控制系统发生冲突。

为避免上述的问题,我们建议把注释文档放入源代码中去。本手册仅描述此种编写代码文档的方法。

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.

Example 3-1GTK-Doc comment block
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif