Package orisdoc

Classe ORisDoc

Classes de ce package :

Packages - Hiérarchie - Index - Constantes et fonctions

Ascendants


Object
  |
  +--- ORisDoc

Description


Classe principale de génération automatique de documentation. Cette classe permet de règler les paramètres de génération, et lance la génération.


Aperçu des attributs


_alphabet Alphabet
_classes Les classes commentées
_destPath Répertoire de destination des documents
_directories Répertoires contenant les packages à commenter
_edit Elément d'interface contenant le répertoire de destination choisi par l'utilisateur
_format Format de génération choisi par l'utilisateur
_generator Générateur de documents à utiliser
_global Les fonctions globales et constantes commentées
_ihm true pour afficher une interface de réglage des paramètres de génération ou false pour lancer automatiquement la génération en se basant uniquement sur les options de la ligne de commande (mode batch)
_index Toutes les entrées d'index
_language Langue choisie par l'utilisateur
_nbLanguages Nombre de langues disponibles dans le dictionnaire
_packages Les packages commentés
_sep Séparateur de répertoires (/ ou \ suivant la plate-forme)
_translator Dictionnaire contenant toutes les traductions


Aperçu des méthodes


addDescendant Relie un parent à un enfant.
delete Appelée lors de la destruction de l'instance.
getLightComment Transforme un commentaire en commentaire abrégé.
initializeTranslator Initialise le traducteur en chargeant les données depuis le dictionnaire translator.
makeDoc Lance le décodage des packages et la génération de la documentation.
new Crée un nouveau parser de packages / générateur de documentation.
parseFile Décode un package.


Référence des attributs


_alphabet

string _alphabet;

Alphabet

_classes

stringDocNodeMap _classes;

Les classes commentées

_destPath

string _destPath;

Répertoire de destination des documents

_directories

string[] _directories;

Répertoires contenant les packages à commenter

_edit

GuiEditLabel _edit;

Elément d'interface contenant le répertoire de destination choisi par l'utilisateur

_format

string _format;

Format de génération choisi par l'utilisateur

_generator

DocGenerator _generator;

Générateur de documents à utiliser

_global

DocNode[] _global;

Les fonctions globales et constantes commentées

_ihm

bool _ihm;

true pour afficher une interface de réglage des paramètres de génération ou false pour lancer automatiquement la génération en se basant uniquement sur les options de la ligne de commande (mode batch)

_index

IndexNode[][] _index;

Toutes les entrées d'index

_language

int _language;

Langue choisie par l'utilisateur

_nbLanguages

int _nbLanguages;

Nombre de langues disponibles dans le dictionnaire

_packages

stringDocNodeMap _packages;

Les packages commentés

_sep

string _sep;

Séparateur de répertoires (/ ou \ suivant la plate-forme)

_translator

string[][] _translator;

Dictionnaire contenant toutes les traductions


Référence des méthodes


addDescendant

void addDescendant(string parent, string child);

Relie un parent à un enfant.

Paramètres
parent - le parent
child - l'enfant

delete

void delete();

Appelée lors de la destruction de l'instance.

getLightComment

string getLightComment(string comment);

Transforme un commentaire en commentaire abrégé.

Paramètres
comment - commentaire à transformer
Valeur de retour
le commentaire abrégé calculé

initializeTranslator

void initializeTranslator();

Initialise le traducteur en chargeant les données depuis le dictionnaire translator.dat.

makeDoc

void makeDoc();

Lance le décodage des packages et la génération de la documentation.

new

void new(bool ihm, string[] options);

Crée un nouveau parser de packages / générateur de documentation.

Paramètres
ihm - true pour afficher l'interface de réglage des paramètres avant de lancer la génération, ou false pour lancer directement la génération en se basant sur la liste d'options (mode batch)
options - liste d'options (ligne de commande)

parseFile

void parseFile(string fileName);

Décode un package.

Paramètres
fileName - le package à décoder


© Virtualys / E.N.I.B. / LI2 - Tous droits réservés
Dernières modifications :