Package orisdoc

Classe DocGenerator

Classes de ce package :

Packages - Hiérarchie - Index - Constantes et fonctions

Ascendants


Object
  |
  +--- DocGenerator

Description


Classe abstraite générant les documents de sortie à partir des informations.


Aperçu des attributs


_baseDirectoryName Nom du répertoire de destination des fichiers de sortie
_data Classe orisdoc principale contenant les données lues depuis les fichiers commentés


Aperçu des méthodes


createClassDocument Crée le document de chaque classe commentée.
createGlobalDocument Crée le document recensant les fonctions globales et les constantes.
createIndexDocument Crée les documents d'index.
createPackagesDocument Crée le document de la liste des packages.
createTreeHierarchyDocument Crée le document de la hiérarchie des classes.
delete Appelée lors de la destruction de l'instance.
getDocumentFooter Obtient le pied de page générique d'un document de sortie.
getDocumentHeader Obtient l'en-tete générique d'un document de sortie.
getTranslation Récupère une entrée du dictionnaire.
new Crée un nouveau générateur.


Référence des attributs


_baseDirectoryName

string _baseDirectoryName;

Nom du répertoire de destination des fichiers de sortie

_data

ORisDoc _data;

Classe orisdoc principale contenant les données lues depuis les fichiers commentés


Référence des méthodes


createClassDocument

void createClassDocument();

Crée le document de chaque classe commentée.

createGlobalDocument

void createGlobalDocument();

Crée le document recensant les fonctions globales et les constantes.

createIndexDocument

void createIndexDocument();

Crée les documents d'index.

createPackagesDocument

void createPackagesDocument();

Crée le document de la liste des packages.

createTreeHierarchyDocument

void createTreeHierarchyDocument();

Crée le document de la hiérarchie des classes.

delete

void delete();

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

getDocumentFooter

string getDocumentFooter();

Obtient le pied de page générique d'un document de sortie.

Valeur de retour
le code source du pied de page

getDocumentHeader

string getDocumentHeader(string title);

Obtient l'en-tete générique d'un document de sortie.

Paramètres
title - le titre du document
Valeur de retour
le code source de l'en-tete

getTranslation

string getTranslation(int key);

Récupère une entrée du dictionnaire.

Paramètres
key - le code (rang dans le fichier dictionnaire) de l'élément à traduire
Valeur de retour
la chaine dans la langue choisie par l'utilisateur

new

void new(ORisDoc data);

Crée un nouveau générateur.

Paramètres
data - la classe orisdoc contenant les données décodées


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