A la suite d’un portage j’ai proposé de migrer les cartouches de documentation des fichiers vers Doxygen, celui-ci présentant l’intérêt de vérifier la cohérence du cartouche des fonctions avec leur signature.
J’ai cherché alors un moyen de créer automatiquement la documentation de l’ensemble des fonctions, mais bien sur je n’ai pas trouvé. C’est quelque chose aberrant, les fonctions se documentent au fur et à mesure qu’elle sont écrites.
Mais je ne suis pas resté les mains vides.
Tout d’abord avec ce plugin eclipse eclox, qui génère automatiquement le cartouche des fonctions. Il intègre très bien Eclipse, avec un wizard pour l’édition du fichier de configuration et des boutons pour lancer la génération.
Cependant je n’ai pas trouvé le moyen de personnaliser le cartouche, par exemple le format des tag ( ‘@’ ou ‘\’ ), ou l’encadrement avec des lignes de ‘=’.
Pour ça le plugin Vim « DoxygenToolKit » répond mieux à mes besoins.
Il m’a suffit d’ajouter dans .vimrc les lignes suivantes :
let g:DoxygenToolkit_briefTag_pre = "\\brief "
let g:DoxygenToolkit_paramTag_pre="\\param "
let g:DoxygenToolkit_returnTag="\\return "
let g:DoxygenToolkit_blockHeader="==========.... ============================"
let g:DoxygenToolkit_blockFooter="==========.... ============================"
Finalement j’utiliserai ces deux outils, le premier pour l’édition, et le second pour gérer la génération de la documentation.
Il me resterait plus qu’à trouver le moyen d’utiliser vim pour sauter directement d’une fonction à l’autre…
