文档
通常,gtkmm风格项目使用Doxygen生成文档,它会读取特殊格式的C++注释并生成HTML文档。你可以直接将这些doxygen可读的注释写到头文件中。
G.7.1. 重用C文档
你可能想重用所封装C库的现有文档。GTK风格的C库通常直接使用gtk-doc,因此在.sgml和.xml文件中有一些gtk-doc格式的源代码注释和一些额外的文档。在glibmm的tools/defs_gen目录中的docextract_to_xml.py脚本,可以读取这些文件并生成一个.xml文件,gmmproc可以使用这个文件生成doxygen注释。gmmproc甚至会尝试转换文档以使其更适合C++ API。
例如:
./docextract_to_xml.py -s ~/checkout/gnome/gtk/gtk/ > gtk_docs.xml
由于此自动转换并不总是合适的,所以你可能希望对特定的方法提供手写的文本。为此可以将函数的XML节点从something_docs.xml文件复制到something_docs_override.xml文件并更改其内容。你也可以在.hg文件中编写自己的文档。