GTK-Doc是一个用来从C代码的注释中生成API文档的工具,尤其适用于使用gobject对象机制编程的项目,并不局限于GTK+或GNOME相关library和程序的文档生成。
主要工作流程基本上,使用GTK-Doc生成API文档,包括几个步骤:
在项目相关目录和Build相关文件中添加GTK-Doc所需参数和相关配置文件。在代码中按照一定的格式规范添加注释(于普通的注释相比,只需要添加非常少的额外信息)使用标准的Build流程(autogen,configure,make等)编译并生成文档修改部分GTK-Doc生成的模板和配置文件,进行一些定制工作,如排除某些函数,定制布局,添加而外的help文档等(这部分工作并不需要每次都做,这些模板和配置文件只在第一次build的时候生成,以后不会自动覆盖)
评论