Package orisdoc

Classe DocNode

Classes de ce package :

Packages - Hiérarchie - Index - Constantes et fonctions

Ascendants


Object
  |
  +--- DocNode

Description


Noeud de documentation. Cette classe sert uniquement de conteneur décrivant complètement un commentaire et le code documenté.


Aperçu des attributs


_children Attributs / méthodes de la classe documentée ou classes des packages
_comment Commentaire principal
_descendants Nom des classes dérivées
_name Nom de l'élément commenté (nom de la classe, de l'atribut, de la méthode, de la constante ou de la macro
_native Elément natif ?
_package Nom du package contenant la définition de l'élément
_param Commentaires param
_paramNames Nom des paramètres décodés
_paramRef Indique si les paramètres sont des références ou non
_paramTypes Type des paramètres décodés
_parent Dans le cas d'une classe, la classe parente
_return Commentaires retour
_returnRef La valeur de retour est une référence ?
_returnType Type de la valeur de retour ou de l'attribut
_see Commentaires voir
_type Type de l'élement :


Aperçu des méthodes


delete Appelé lors de la destruction du noeud.
lessThan Méthode de comparaison de noeud.
new Crée un nouveau noeud.


Référence des attributs


_children

DocNode[] _children;

Attributs / méthodes de la classe documentée ou classes des packages

_comment

string _comment;

Commentaire principal

_descendants

string[] _descendants;

Nom des classes dérivées

_name

string _name;

Nom de l'élément commenté (nom de la classe, de l'atribut, de la méthode, de la constante ou de la macro

_native

bool _native;

Elément natif ?

_package

string _package;

Nom du package contenant la définition de l'élément

_param

string[] _param;

Commentaires param

_paramNames

string[] _paramNames;

Nom des paramètres décodés

_paramRef

bool[] _paramRef;

Indique si les paramètres sont des références ou non

_paramTypes

string[] _paramTypes;

Type des paramètres décodés

_parent

string _parent;

Dans le cas d'une classe, la classe parente

_return

string _return;

Commentaires retour

_returnRef

bool _returnRef;

La valeur de retour est une référence ?

_returnType

string _returnType;

Type de la valeur de retour ou de l'attribut

_see

string[] _see;

Commentaires voir

_type

int _type;

Type de l'élement : -1 = package, 0 = classe, 1 = methode, 2 = attribut, 3 = fonction/macro, 4 = constante


Référence des méthodes


delete

void delete();

Appelé lors de la destruction du noeud.

lessThan

bool lessThan(Object obj);

Méthode de comparaison de noeud.

Paramètres
obj - l'objet à comparer
Valeur de retour
true si l'instance est inférieure à l'argument, false sinon

new

void new();

Crée un nouveau noeud.


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