Voici un outil pratique que j'utilise pour mes projets ; Doxygen, générateur de documentation technique!
Les présentations sont faites; maintenant, que fait-il ?
Il est capable de parcourir vos dossiers de sources en profondeur, de générer la dîte doc en html, LaTeX, RTF, Man (format des manpages sous unix) ou encore XML.
Il est possible de lui indiquer quel est le langage du code source (parmi c, c++, c# ou java) afin qu'il affine au mieux la doc générée.
Doxygen reconnait différentes "normes" de commentaires dont vous pouvez consulter la liste
ici.
Vous pouvez
télécharger les versions pour unix ou windows sur le site du logiciel.
Mais surtout le grand avantage de Doxygen est qu'il permet d'avoir une doc qui tient la route, sans se fouler!
Doxygen
Petite astuce pour générer un fichier PDF (je n'ai testé cette solution que sous unix) :
Dans l'interface graphique (DoxyWizard), deux solutions :
soit cliquer sur Expert -> LaTeX : cocher "GENERATE_LATEX", "PDF_HYPERLINKS", "USE_PDFLATEX"
soit cliquer sur Wizard -> Output : cocher "LaTeX" -> as intermediate format for hyperlinked PDF
Solution Expert ou Wizard, n'oubliez pas de remplir l'onglet "Project" ainsi que vérifier les autres!
Cliquer sur OK
Enregistrer la configuration
Choisir le répertoire de travail de Doxygen
Lancez-le!
Ensuite allez dans le répertoire latex qui a du être créé si tout s'est bien passé, et tapez la commande suivante.
$ make pdf
et voila, vous avez un joli PDF répondant au nom de refman.pdf!