dolibarr/doc/dev/php/html/graph_legend.html

74 lines
4.6 KiB
HTML
Raw Normal View History

2004-07-15 14:40:07 +02:00
<!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<EFBFBD>r<EFBFBD> par Doxygen 1.3.7 -->
2004-07-15 20:43:48 +02:00
<div class="qindex"><a class="qindex" href="index.html">Page&nbsp;principale</a> | <a class="qindex" href="classes.html">Liste&nbsp;alphab<EFBFBD>tique</a> | <a class="qindex" href="annotated.html">Liste&nbsp;des&nbsp;classes</a> | <a class="qindex" href="files.html">Liste&nbsp;des&nbsp;fichiers</a> | <a class="qindex" href="functions.html">Membres&nbsp;de&nbsp;classe</a> | <a class="qindex" href="globals.html">Membres&nbsp;de&nbsp;fichier</a></div>
2004-07-15 14:40:07 +02:00
<h1>L<EFBFBD>gende du graphe</h1>Cette page explique comment interpr<70>ter les graphes g<>n<EFBFBD>r<EFBFBD>s par doxygen.<p>
Consid<EFBFBD>rez l'exemple suivant: <pre><div class="fragment"><span class="comment">/*! Classe invisible <20> cause d'une troncature */</span>
<span class="keyword">class </span>Invisible { };
<span class="comment"></span>
<span class="comment">/*! Classe tronqu<71>e, la relation d'h<>ritage est masqu<71>e */</span>
<span class="keyword">class </span>Truncated : <span class="keyword">public</span> Invisible { };
<span class="comment"></span>
<span class="comment">/*! Classe non document<6E>e avec des commentaires Doxygen */</span>
<span class="keyword">class </span>Undocumented { };
<span class="comment"></span>
<span class="comment">/*! Classe d<>riv<69>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<6F>le de classe */</span>
<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span>Templ { };
<span class="comment"></span>
<span class="comment">/*! Classe d<>riv<69>e par h<>ritage prot<6F>g<EFBFBD> */</span>
<span class="keyword">class </span>ProtectedBase { };
<span class="comment"></span>
<span class="comment">/*! Classe d<>riv<69>e par h<>ritage priv<69> */</span>
<span class="keyword">class </span>PrivateBase { };
<span class="comment"></span>
<span class="comment">/*! Classe utilis<69>e par la classe d<>riv<69>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&lt;int&gt;
{
<span class="keyword">private</span>:
Used *m_usedClass;
};
</div></pre>Si la valeur 240 est attribu<62>e au tag <code>MAX_DOT_GRAPH_HEIGHT</code> du fichier de configuration, cela g<>n<EFBFBD>rera le graphe suivant:&lt;p&gt;<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<70>sente la structure ou la classe pour laquelle le graphe est g<>n<EFBFBD>r<EFBFBD>. </li>
<li>
Un rectangle avec un bord noir indique une classe ou une structure document<6E>e. </li>
<li>
Un rectangle avec un bord gris indique une classe ou une structure non document<6E>e. </li>
<li>
Un rectangle avec un bord rouge indique une structure ou une classe document<6E>e pour laquelle des relations d'h<>ritage ou de collaboration manquent. Un graphe est tronqu<71> s'il n'entre pas dans les limites sp<73>cifi<66>es.</li>
</ul>
Les fl<66>ches ont la signification suivante: <ul>
<li>
Une fl<66>che bleu fonc<6E> est utilis<69>e pour visualiser une relation d'h<>ritage public entre deux classes. </li>
<li>
Une fl<66>che vert fonc<6E> est utilis<69>e pour une relation d'h<>ritage prot<6F>g<EFBFBD>. </li>
<li>
Une fl<66>che rouge fonc<6E> est utilis<69>e pour une relation d'h<>ritage priv<69>. </li>
<li>
Une fl<66>che violette en pointill<6C>s est utilis<69>e si une classe est contenue ou utilis<69>e par une autre classe. La fl<66>che est <20>tiquet<65>e avec la ou les variable(s) qui permettent d'acc<63>der <20> la classe ou structure point<6E>e. </li>
<li>
Une fl<66>che verte en pointill<6C>s indique une relation entre une classe instanci<63>e et le mod<6F>le de classe utilis<69>. La fl<66>che est <20>tiquet<65>e avec les param<61>tres de mod<6F>le de la classe instanci<63>e. </li>
</ul>
2004-07-16 08:41:58 +02:00
<hr size="1"><address style="align: right;"><small>G<EFBFBD>n<EFBFBD>r<EFBFBD> le Fri Jul 16 08:51:53 2004 pour dolibarr par
2004-07-15 14:40:07 +02:00
<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>