LesOlivex

Serveis informàtics




Documentar scripts bash con doxygen

Category : bash, Documentación de código, doxygen des 21st, 2014

doxygen_manualDoxygen tiene la capacidad de hacer un filtrado antes de procesar los archivos, para activarlo creamos un script en bash que debe contener lo siguiente:

cat "$1" | sed 's/##</\/\/\/</g' | sed 's/##/\/\/\//g' | sed '/\/\/\/\|^$/!s/$/;/'

En la configuración de doxygen añadimos los siguientes cambios:

INPUT_FILTER           = "../../proyectos/mytrabajos/magdoxygen --filtra bash"
FILTER_SOURCE_FILES    = NO

Modificar el script que yo puse por el vuestro

A la hora de documentar el código marco con dos ‘##’ los comentarios para doxygen, en caso de hacerlo posteriormente ‘##<‘ el script los transformara en /// y ///< para que doxygen los entienda.

Y eso es todo.


Leave a Reply

Your email address will not be published. Required fields are marked *