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,25 +3,41 @@
{\ttfamily \#include "{}../include/function.\+h"{}}\newline
{\ttfamily \#include $<$stdio.\+h$>$}\newline
{\ttfamily \#include $<$stdlib.\+h$>$}\newline
{\ttfamily \#include $<$string.\+h$>$}\newline
Graphe des dépendances par inclusion de read.\+c\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{read_8c__incl}
\end{center}
\end{figure}
% FIG 0
\doxysubsubsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
\textbf{ vect} $\ast$ \textbf{ file\+To\+Tab2D} (const char $\ast$name\+\_\+file, char $\ast$$\ast$tab, const unsigned N, \textbf{ vect} $\ast$player, int $\ast$nbr\+\_\+targets)
\begin{DoxyCompactList}\small\item\em La fonction permet de stocker la zone de jeu en fonction de la lecture d\textquotesingle{}un fichier. \end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{DoxyCompactList}\small\item\em La fonction permet de stocker la zone de jeu en fonction de la lecture d\textquotesingle{}un fichier. \end{DoxyCompactList}\item
int \textbf{ count\+Custom\+Maps} (char $\ast$name\+\_\+directory)
\begin{DoxyCompactList}\small\item\em La fonction permet de compter le nombre de maps custom dans le fichier des maps. \end{DoxyCompactList}\item
char $\ast$$\ast$ \textbf{ generator\+Menu} (char $\ast$name\+\_\+directory, \textbf{ vect} $\ast$size, \textbf{ vect} $\ast$pos\+\_\+player)
\begin{DoxyCompactList}\small\item\em La fonction permet de creer la zone de jeu du menu en fonction du nombre de maps custom. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Description détaillée}
Ce fichier est le programe qui lit d\textquotesingle{}autre fichier, nottament les maps.
\doxysubsection{Documentation des fonctions}
\index{read.c@{read.c}!countCustomMaps@{countCustomMaps}}
\index{countCustomMaps@{countCustomMaps}!read.c@{read.c}}
\doxysubsubsection{countCustomMaps()}
{\footnotesize\ttfamily \label{read_8c_a33f349fef5188584733f08c3a0eddbf2}
int count\+Custom\+Maps (\begin{DoxyParamCaption}\item[{char $\ast$}]{name\+\_\+directory}{}\end{DoxyParamCaption})}
La fonction permet de compter le nombre de maps custom dans le fichier des maps.
\begin{DoxyParams}{Paramètres}
{\em name\+\_\+directory} & Le nom du dossier contenant les maps. return Le nombre de maps custom. \\
\hline
\end{DoxyParams}
Voici le graphe des appelants de cette fonction \+:
% FIG 1
\index{read.c@{read.c}!fileToTab2D@{fileToTab2D}}
\index{fileToTab2D@{fileToTab2D}!read.c@{read.c}}
\doxysubsubsection{fileToTab2D()}
@@ -48,3 +64,24 @@ La fonction permet de stocker la zone de jeu en fonction de la lecture d\textquo
\begin{DoxyReturn}{Renvoie}
Vect La fonction renvoie le tableau des coordonnée des points d\textquotesingle{}interer.
\end{DoxyReturn}
\index{read.c@{read.c}!generatorMenu@{generatorMenu}}
\index{generatorMenu@{generatorMenu}!read.c@{read.c}}
\doxysubsubsection{generatorMenu()}
{\footnotesize\ttfamily \label{read_8c_aa77b744c6eb2919d8d69ae718210ce55}
char $\ast$$\ast$ generator\+Menu (\begin{DoxyParamCaption}\item[{char $\ast$}]{name\+\_\+directory}{, }\item[{\textbf{ vect} $\ast$}]{size}{, }\item[{\textbf{ vect} $\ast$}]{pos\+\_\+player}{}\end{DoxyParamCaption})}
La fonction permet de creer la zone de jeu du menu en fonction du nombre de maps custom.
\begin{DoxyParams}{Paramètres}
{\em name\+\_\+directory} & Le nom du dossier contenant les maps. \\
\hline
{\em size} & La taille de la zone de jeu. \\
\hline
{\em pos\+\_\+player} & La position du joueur dans le menu. \\
\hline
\end{DoxyParams}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
% FIG 2