| 1 | [[PageOutline]] |
| 2 | |
| 3 | = Introducción a Doxygen = |
| 4 | Doxygen es un documentador automático, capaz de extraer la documentación de los propios fuentes del programa. |
| 5 | |
| 6 | = Instalación Doxygen = |
| 7 | Apt-get install doxygen doxygen-doc doxygen-gui graphviz |
| 8 | |
| 9 | = Comentar el código doxygen = |
| 10 | Los tags de doxygen deben estar dentro de lineas comentadas en el código, |
| 11 | así en el lenguaje c seria: |
| 12 | {{{ |
| 13 | para modo de comentario /*, se reemplaza por /** y para terminar solo */ |
| 14 | comentarios de una sola línea: //, es necesario añadirles una barra más: /// |
| 15 | }} |
| 16 | así para el lenguaje shell scripts bash |
| 17 | {{{ |
| 18 | anteponemos el comentario de bash, al comentario de c, asi tendriamos #/** y para terminar #*/ |
| 19 | }}} |
| 20 | |
| 21 | = tag de doxygen = |
| 22 | |
| 23 | |
| 24 | |
| 25 | |