forked from Wavyzz/dolibarr
74 lines
4.6 KiB
HTML
74 lines
4.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>dolibarr: Graph Legend</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Généré par Doxygen 1.3.7 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Page principale</a> | <a class="qindex" href="classes.html">Liste alphabétique</a> | <a class="qindex" href="annotated.html">Liste des classes</a> | <a class="qindex" href="files.html">Liste des fichiers</a> | <a class="qindex" href="functions.html">Membres de classe</a> | <a class="qindex" href="globals.html">Membres de fichier</a></div>
|
|
<h1>Légende du graphe</h1>Cette page explique comment interpréter les graphes générés par doxygen.<p>
|
|
Considérez l'exemple suivant: <pre><div class="fragment"><span class="comment">/*! Classe invisible à cause d'une troncature */</span>
|
|
<span class="keyword">class </span>Invisible { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Classe tronquée, la relation d'héritage est masquée */</span>
|
|
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Classe non documentée avec des commentaires Doxygen */</span>
|
|
<span class="keyword">class </span>Undocumented { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Classe dérivée par héritage public */</span>
|
|
<span class="keyword">class </span>PublicBase : <span class="keyword">public</span> Truncated { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Un modèle de classe */</span>
|
|
<span class="keyword">template</span><<span class="keyword">class</span> T> <span class="keyword">class </span>Templ { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Classe dérivée par héritage protégé */</span>
|
|
<span class="keyword">class </span>ProtectedBase { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Classe dérivée par héritage privé */</span>
|
|
<span class="keyword">class </span>PrivateBase { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Classe utilisée par la classe dérivée */</span>
|
|
<span class="keyword">class </span>Used { };
|
|
<span class="comment"></span>
|
|
<span class="comment">/*! Super-classe qui hérite de plusieurs autres classes */</span>
|
|
<span class="keyword">class </span>Inherited : <span class="keyword">public</span> PublicBase,
|
|
<span class="keyword">protected</span> ProtectedBase,
|
|
<span class="keyword">private</span> PrivateBase,
|
|
<span class="keyword">public</span> Undocumented
|
|
<span class="keyword">public</span> Templ<int>
|
|
{
|
|
<span class="keyword">private</span>:
|
|
Used *m_usedClass;
|
|
};
|
|
</div></pre>Si la valeur 240 est attribuée au tag <code>MAX_DOT_GRAPH_HEIGHT</code> du fichier de configuration, cela génèrera le graphe suivant:<p><center><div align="center">
|
|
<img src="graph_legend.png" alt="graph_legend.png" alt>
|
|
</div>
|
|
</center> <p>
|
|
Les rectangles du graphe ci-dessus ont la signification suivante: <ul>
|
|
<li>
|
|
Un rectangle plein noir représente la structure ou la classe pour laquelle le graphe est généré. </li>
|
|
<li>
|
|
Un rectangle avec un bord noir indique une classe ou une structure documentée. </li>
|
|
<li>
|
|
Un rectangle avec un bord gris indique une classe ou une structure non documentée. </li>
|
|
<li>
|
|
Un rectangle avec un bord rouge indique une structure ou une classe documentée pour laquelle des relations d'héritage ou de collaboration manquent. Un graphe est tronqué s'il n'entre pas dans les limites spécifiées.</li>
|
|
</ul>
|
|
Les flèches ont la signification suivante: <ul>
|
|
<li>
|
|
Une flèche bleu foncé est utilisée pour visualiser une relation d'héritage public entre deux classes. </li>
|
|
<li>
|
|
Une flèche vert foncé est utilisée pour une relation d'héritage protégé. </li>
|
|
<li>
|
|
Une flèche rouge foncé est utilisée pour une relation d'héritage privé. </li>
|
|
<li>
|
|
Une flèche violette en pointillés est utilisée si une classe est contenue ou utilisée par une autre classe. La flèche est étiquetée avec la ou les variable(s) qui permettent d'accéder à la classe ou structure pointée. </li>
|
|
<li>
|
|
Une flèche verte en pointillés indique une relation entre une classe instanciée et le modèle de classe utilisé. La flèche est étiquetée avec les paramètres de modèle de la classe instanciée. </li>
|
|
</ul>
|
|
<hr size="1"><address style="align: right;"><small>Généré le Thu Jul 15 20:50:39 2004 pour dolibarr par
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
|
|
</body>
|
|
</html>
|