Génération de documentation

< < E-NEF > >

Prog. Perl | Art Roman | Voyager | Cartes

Next: Voyager Up: Java Previous: Compilation Table des matières Index

Génération de documentation

Il est possible de générer une documentation au format html en utilisant la commande javadoc. Pour exécuter la commande javadoc, il faut toujours se placer dans le même répertoire que orchid.

La commande que nous utilisons est la suivante :

javadoc -author -d orchid/doc/ orchid.agent orchid.gui orchid.object orchid.server

Cela génère les fichiers html dans le sous-répertoire orchid/doc. L'option -author affiche le nom du membre de l'équipe qui a écrit telle ou telle classe.

En résumé l'utilisation est la suivante :

 javadoc <-author> <-d where_to_put_the_doc> package_name1 package_name2 ...

Exemple :

I5:~/javaProgs$ javadoc -author -d orchid/doc/ orchid.agent orchid.gui orchid.object 
orchid.server

Attention : Il est obligatoire de générer la documentation pour tous les packages et fichiers en même temps. L'utilisation de javadoc écrase en effet tous les fichiers .html qui pourraient être déjà présents.

epierre@e-nef.com