Documentation : Utiliser le programme
|
Créer la documentation
Lorsque vous avez une version utilisable de Header Browser, vous pouvez l'utiliser à partir de la ligne de commande pour créer de la documentation. Le type de sortie par défaut est le HTML, avec la vue particulière à Header Browser en cinq colonnes, qui est vraiment rapide et facile à utiliser pour explorer vos API. Regardez ces exemples :
Crée une répertoire 'hbresult-html' dans le répertoire courant, et met dedans la documentation HTML résultante. $ headerbrowser *.h
Comme précédemment, mais contient la documentation de tous les fichiers d'en-tête. $ headerbrowser -o ../tmp toto.h
Utilise l'option '-o' pour indiquer le répertoire où doit être créé 'hbresult-html'. $ headerbrowser -t h2h *.h
Utilise l'option '-t' pour indiquer le type de conversion. $ headerbrowser -l eng *.h
Utilise l'option '-l' pour indiquer la langue de sortie.
Retour à la page principale | ||
Copyright © 2000-2001 | | | Informations sur la licence |