Documentación
En general, los proyectos de gtkmm usan Doxygen, que lee comentarios de C++ con un formato específico y genera documentación HTML. Puede escribir estos comentarios de Doxygen directamente en los archivos de cabecera.
G.7.1. Reutilizar la documentación de C
Tal vez quiera reutilizar documentación que exista para la biblioteca de C que está envolviendo. Las bibliotecas GTK de C típicamente usan gtk-doc y por lo tanto tienen comentarios en el código fuente en formato de gtk-doc y alguna documentación adicional en archivos .sgml y .xml. El script «docextract_to_xml.py», de la carpeta tools/defs_gen de glibmm, puede leer estos archivos y crear un archivo .xml que gmmproc puede usar para generar comentarios de doxygen. gmmproc incluso intentará transformar la documentación para hacerla más apropiada para una API de C++.
Por ejemplo,
./docextract_to_xml.py -s ~/checkout/gnome/gtk+/gtk/ -s ~/checkout/gnome/gtk+/docs/reference/gtk/ > gtk_docs.xml
Dado que esta transformación automática no es siempre apropiada, tal vez quiera proporcionar texto escrito a mano para un método particular. Puede hacer esto copiando el nodo XML para la función de su archivo something_docs.xml al archivo something_docs_override.xml y cambiando el contenido.
G.7.2. Estructura de construcción de la documentación
Si copió el esqueleto del árbol de fuentes en mm-common y sustituyó los marcadores de posición, entonces ya tendrá archivos Makefile.am y Doxyfile.in apropiados. Con la configuración de construcción de mm-common, la lista de los archivos de entrada de Doxygen no se define en el archivo de configuración de Doxygen, sino que se pasa desde make a la entrada estándar de doxygen. La variable doc_input define la lista de archivos de entrada en el archivo Makefile.am.