ROBODoc

Envoyer Imprimer PDF

ROBODoc

Un site sur robodoc : Lien et le manuel qui s'y trouve.

Pour l'installer il suffit de suivre les indications du site. Sinon vous pouvez prendre directement le binaire (version robodoc-4.99.34 –> pour 64bit)

ROBODoc est un outil de documentation pour vos codes. Il permet de créer une documentation html, pdf… automatiquement du moment que vous avez bien formaté les commentaires de votre code.

ROBODoc n'a pas d'interface graphique. Il faut donc tapez en ligne de commande les actions que vous voulez que robodoc exécute. Pour ce faire robodoc dispose de plusieurs options. Effectuez la commande suivante :

$ robodoc --help

ce qui vous permettra de voir les options et la syntaxe d'utilisation.

Pour la documentation C de codes :

$ robodoc --src . --doc ./doc/html --multidoc --html --index

Les commandes obligatoires :

  • - - src . : indique où se trouvent les codes sources (ici . signifie le répertoire courant).
  • - - doc ./doc/html : indique le dossier dans lequel les .html seront placés.
  • - - multidoc - - html : pour indiquer que l'on utilise plusieurs codes sources et que le format d'arrivée de la documentation est le html.

Les options :

  • - - index : permet de créer un masterindex.html liant tous les .html pour une navigation plus aisée dans la documentation.
  • - - toc : permet de creer une petite table des matière sur chaque page de la documentation.

Pour la documentation C de codes :

On utilise le formatage avec / et *. Tout ce que l'on veut faire apparaître dans la documentation doit être encadré par une "balise" de début et une de fin.

  • balise de debut :
/****f* NOM_DE_ITEM
  • balise de fin :
/*****/
ou
******* (par exemple, du moment qu'il y a assez d'étoile)
ou
*******/
...

Exemple :

/****f* nom_de_item
CECI SERA DANS LA DOCUMENTATION
*/
CECI AUSSI
/*****/
MAIS PAS CA

Il faut de plus respecter certains critères pour les documentations d'en-tête à l'aide de mots-clef :

Pour les .c on peut écrire, le "f" est pour dire que l'on documente une "fonction" :

/****f* nom_du_fichier_source/nom_de_item
* NAME
* ecrire le nom de l'item
* USAGE
* ecrire l'usage
* DESCRIPTION
* ecrire la description
* EXAMPLE
* ecrire un exemple
* INPUTS
* les inputs
* OUTPUT
* les outputs
* RETURN VALUE
* la valeur retournée
* CREATION DATE
* date de creation
* MODIFICATION HISTORY
* historique de modification
* NOTES
* des notes
* AUTHOR
* l'auteur
* SOURCE
*/

//code source

/*****/

Tous les mots-clefs en MAJUSCULE apparaiteront en gras dans la documentation et comme des titres.

Pour les .h on peut écrire, le "h" est pour dire qu'on documente un "header" :

/****h* nom_du_fichier_source/nom_de_item
* NAME
* nom du fichier
* DESCRIPTION
* description du fichier
* SOURCE
*/
 
//code source
 
/******
*
* code non repéré par robodoc car derrière la balise de fin
*/

Pour en savoir plus sur les "header types" : Lien

Remarque : l'utlisation des types signalés par "f" ou "h" ou d'autres n'est pas obligatoire mais elle peut aider si l'on veut trier sa documentation.

Pour en savoir plus sur les mots-clef disponibles : Lien et pour créer ses propres mots-clef voir la section suivante..

Suivez le lien suivant : Lien

Mise à jour le Samedi, 06 Février 2010 11:57