fix doxy comment

This commit is contained in:
2025-01-05 18:29:43 +01:00
parent 4cd165867e
commit e7480472a3
82 changed files with 1310 additions and 470 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Sokoban: Référence du fichier read.c</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -34,7 +34,7 @@
</table>
</div>
<!-- end header part -->
<!-- Généré par Doxygen 1.12.0 -->
<!-- Généré par Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -97,6 +97,7 @@ $(function(){ initResizable(false); });
<div class="textblock"><code>#include &quot;../include/function.h&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Graphe des dépendances par inclusion de read.c:</div>
<div class="dyncontent">
@@ -128,10 +129,46 @@ Fonctions</h2></td></tr>
<tr class="memitem:a223592601b10fb9487363ff4bb417d5d" id="r_a223592601b10fb9487363ff4bb417d5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structVecteur.html">vect</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a223592601b10fb9487363ff4bb417d5d">fileToTab2D</a> (const char *name_file, char **tab, const unsigned N, <a class="el" href="structVecteur.html">vect</a> *player, int *nbr_targets)</td></tr>
<tr class="memdesc:a223592601b10fb9487363ff4bb417d5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">La fonction permet de stocker la zone de jeu en fonction de la lecture d'un fichier. <br /></td></tr>
<tr class="separator:a223592601b10fb9487363ff4bb417d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33f349fef5188584733f08c3a0eddbf2" id="r_a33f349fef5188584733f08c3a0eddbf2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33f349fef5188584733f08c3a0eddbf2">countCustomMaps</a> (char *name_directory)</td></tr>
<tr class="memdesc:a33f349fef5188584733f08c3a0eddbf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">La fonction permet de compter le nombre de maps custom dans le fichier des maps. <br /></td></tr>
<tr class="separator:a33f349fef5188584733f08c3a0eddbf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa77b744c6eb2919d8d69ae718210ce55" id="r_aa77b744c6eb2919d8d69ae718210ce55"><td class="memItemLeft" align="right" valign="top">char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa77b744c6eb2919d8d69ae718210ce55">generatorMenu</a> (char *name_directory, <a class="el" href="structVecteur.html">vect</a> *size, <a class="el" href="structVecteur.html">vect</a> *pos_player)</td></tr>
<tr class="memdesc:aa77b744c6eb2919d8d69ae718210ce55"><td class="mdescLeft">&#160;</td><td class="mdescRight">La fonction permet de creer la zone de jeu du menu en fonction du nombre de maps custom. <br /></td></tr>
<tr class="separator:aa77b744c6eb2919d8d69ae718210ce55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description détaillée</h2>
<div class="textblock"><p>Ce fichier est le programe qui lit d'autre fichier, nottament les maps. </p>
</div><h2 class="groupheader">Documentation des fonctions</h2>
<a id="a33f349fef5188584733f08c3a0eddbf2" name="a33f349fef5188584733f08c3a0eddbf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33f349fef5188584733f08c3a0eddbf2">&#9670;&#160;</a></span>countCustomMaps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int countCustomMaps </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name_directory</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>La fonction permet de compter le nombre de maps custom dans le fichier des maps. </p>
<dl class="params"><dt>Paramètres</dt><dd>
<table class="params">
<tr><td class="paramname">name_directory</td><td>Le nom du dossier contenant les maps. return Le nombre de maps custom. </td></tr>
</table>
</dd>
</dl>
<div class="dynheader">
Voici le graphe des appelants de cette fonction :</div>
<div class="dyncontent">
<div class="center"><img src="read_8c_a33f349fef5188584733f08c3a0eddbf2_icgraph.png" border="0" usemap="#aread_8c_a33f349fef5188584733f08c3a0eddbf2_icgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a223592601b10fb9487363ff4bb417d5d" name="a223592601b10fb9487363ff4bb417d5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a223592601b10fb9487363ff4bb417d5d">&#9670;&#160;</a></span>fileToTab2D()</h2>
@@ -179,12 +216,53 @@ Fonctions</h2></td></tr>
</dl>
<dl class="section return"><dt>Renvoie</dt><dd>Vect La fonction renvoie le tableau des coordonnée des points d'interer. </dd></dl>
</div>
</div>
<a id="aa77b744c6eb2919d8d69ae718210ce55" name="aa77b744c6eb2919d8d69ae718210ce55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa77b744c6eb2919d8d69ae718210ce55">&#9670;&#160;</a></span>generatorMenu()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ** generatorMenu </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name_directory</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVecteur.html">vect</a> *</td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structVecteur.html">vect</a> *</td> <td class="paramname"><span class="paramname"><em>pos_player</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>La fonction permet de creer la zone de jeu du menu en fonction du nombre de maps custom. </p>
<dl class="params"><dt>Paramètres</dt><dd>
<table class="params">
<tr><td class="paramname">name_directory</td><td>Le nom du dossier contenant les maps. </td></tr>
<tr><td class="paramname">size</td><td>La taille de la zone de jeu. </td></tr>
<tr><td class="paramname">pos_player</td><td>La position du joueur dans le menu. </td></tr>
</table>
</dd>
</dl>
<div class="dynheader">
Voici le graphe d'appel pour cette fonction :</div>
<div class="dyncontent">
<div class="center"><img src="read_8c_aa77b744c6eb2919d8d69ae718210ce55_cgraph.png" border="0" usemap="#aread_8c_aa77b744c6eb2919d8d69ae718210ce55_cgraph" alt=""/></div>
</div>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Généré par&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
Généré par&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1
</small></address>
</div><!-- doc-content -->
</body>