Doxygen es la herramienta de facto estándar para generar documentación a partir de fuentes C++ anotadas, pero también admite otros lenguajes de programación populares como C, Objective-C, C#, PHP, Java, Python, IDL (sabores Corba, Microsoft y UNO/OpenOffice), Fortran, VHDL, Tcl y en cierta medida D.
Doxygen puede ayudarte de tres maneras:
- Puede generar un navegador de documentación en línea (en HTML) y/o un manual de referencia fuera de línea (en $mbox{LaTeX}$) a partir de un conjunto de archivos fuente documentados. También hay soporte para generar salida en RTF (MS-Word), PostScript, PDF con hipervínculos, HTML comprimido y páginas de manual de Unix. La documentación se extrae directamente de las fuentes, lo que facilita mantener la documentación consistente con el código fuente.
- Puedes configurar doxygen para extraer la estructura del código de archivos fuente no documentados. Esto es muy útil para encontrar rápidamente tu camino en grandes distribuciones de código fuente. Doxygen también puede visualizar las relaciones entre los diversos elementos mediante gráficos de dependencia de inclusión, diagramas de herencia y diagramas de colaboración, que se generan automáticamente.
- También puedes usar doxygen para crear documentación normal (como hice para el manual de usuario de doxygen y el sitio web).
Nota: Aunque el software se clasifica como gratuito, en realidad es donationware. Por favor, considera hacer una donación para ayudar a apoyar el desarrollo.