Package orisdoc

Classe PlainDocGenerator

Classes de ce package :

Packages - Hiérarchie - Index - Constantes et fonctions

Ascendants


Object
  |
  +--- DocGenerator
         |
         +--- PlainDocGenerator

Description


Classe générant les documents de sortie dans un format propriétaire à partir des informations.


Aperçu des attributs



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.
new Crée un nouveau générateur.


Référence des attributs



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

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 :