Syntaxe de Commande de Autodoc

Last updated: 30. 1. 2002

Utilisation:

autodoc.exe
[ -v <NiveaudeVerbosité> ]
-html <RépertoiredeSortie>
{
[ -parse ]
[ -name <RepositoryName> ]
-lg <LangagedeProgrammation>
{
[ -p <NomduProjet> <RacineduProjet> ]
{
-t <RépertoireSource>*
-d <RépertoireSource>*
-f <FichierSource>*
}+
}+
}

Légende:

<Texte>
paramètre de ligne de commande
[ ]
options
{ }
Bloc d'options connectées.
La séquence d'options non connectées importe peu. Ainsi, les options html ou -v peuvent être utilisées avant ou après toutes les options de traitement.
+
une ou plusieurs fois
*
aucune ou plusieurs fois


Explication des Options

-v <NiveaudeVerbosité> Uniquement pour le débogage. les Bits 1, 2 et 4 dans n'importe quelle combinaison donnent une sortie différente.
-html <RépertoiredeSortie>
Indique le répertoire où une version HTML du document sera créée.
-parse Fait démarrer le bloc dans lequel se trouvent toutes les options de traitement. Ceci peut être omis, parce que les options de traitement sont identifiables sans, mais cela pourrait en rendre la lecture plus claire.
-name <RépertoireSource> Ce nom apparaît en tant que titre de la documentation (à présent uniquement dans la version C++).
-lg <LangagedeProgrammation>
Les valeurs possibles sont:

c++
Celle-ci traite tous les fichiers se terminant en .hxx et .h .
idl
Celle-ci traite tous les fichiers se terminant en .idl .
-p avec -t/-d/-f: S'il existe plus d'un projet, l'option -p est obligatoire pour chacun.

Le répertoire donné avec l'option -p est le répertoire racine du projet.
Si aucune option -p n'a été donnée, le répertoire de travail est traité comme le répertoire racine.

Tous les chemins donnés avec les options -t/-d/-f sont relatifs à la racine. Il est possible d'utiliser "." en tant qu'argument pour -t ou -d.

Chacune de -t/-d/-f peut prendre plusieurs arguments:
On pourrait écrire "-f fichier1.hxx fichier2.hxx fichier_xyz.hxx"
Après chaque option -p (ou après -lg, si aucune option -p n'a été donnée), il doit y avoir au moins une des trois options suivantes :
-t Tree, ce qui veut dire: inclure les sous-répertoires
-d Directory, ce qui veut dire: aucun sous-répertoire
-f File", ce qui veut dire: un fichier seul se terminant avec l'extension indiquée.
Cette option permet également de traiter des fichiers se terminant différemment de ceux impliqués par l'option -lg.



Traduction Alex Thurgood

Retour à l'index Labo


 

OpenOffice.org native tongue concept and francophone project are built for you with pride by Guy Capra (Alomphega).
This fr project is also led and maintained by Sophie Gautier.