dukantic/Sokoban
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix doxy comment

Browse Source
This commit is contained in:
Dukantic
2025-01-05 18:29:43 +01:00
parent 4cd165867e
commit e7480472a3
82 changed files with 1310 additions and 470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

169
rapport/latex/function_8c.tex
View File

@@ -3,7 +3,9 @@
{\ttfamily \#include "{}../include/function.\+h"{}}\newline
{\ttfamily \#include "{}../include/display.\+h"{}}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+events.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+image.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+keycode.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+rect.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+render.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+scancode.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+timer.\+h$>$}\newline
@@ -12,26 +14,20 @@
{\ttfamily \#include $<$stdlib.\+h$>$}\newline
{\ttfamily \#include $<$time.\+h$>$}\newline
Graphe des dépendances par inclusion de function.\+c\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{function_8c__incl}
\end{center}
\end{figure}
% FIG 0
\doxysubsubsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
char $\ast$$\ast$ \textbf{ creat\+Area2D} (const unsigned int N)
\begin{DoxyCompactList}\small\item\em Cette fonction permet de creer une liste 2D carre. \end{DoxyCompactList}\item
void \textbf{ free2D} (char $\ast$$\ast$tab, int N)
char $\ast$$\ast$ \textbf{ creat\+Area2D} (const int x, const int y)
\begin{DoxyCompactList}\small\item\em Cette fonction permet de creer une liste 2D. \end{DoxyCompactList}\item
void \textbf{ free2D} (char $\ast$$\ast$tab, int x)
\begin{DoxyCompactList}\small\item\em Cette fontion permet de liberer l\textquotesingle{}espace tu tableau 2D de char. \end{DoxyCompactList}\item
char \textbf{ can\+IGo\+Direction} (char value\+Of\+NCase, char value\+Of\+NPlus\+One\+Case)
\begin{DoxyCompactList}\small\item\em La fontction permet de savoir si le joueur peut ce deplacer dans une direction. \end{DoxyCompactList}\item
void \textbf{ move} (char $\ast$$\ast$tab, \textbf{ vect} $\ast$player\+Pos, \textbf{ vect} direction, \textbf{ score} $\ast$score\+\_\+user)
\begin{DoxyCompactList}\small\item\em Cette fonction effectue les deplacements du joueur et des boites en fonction de la situation. \end{DoxyCompactList}\item
void \textbf{ in\+Game\+Loop} (char $\ast$$\ast$tab2d, int N, \textbf{ vect} $\ast$player\+Pos, \textbf{ vect} $\ast$targets, int nbr\+\_\+targets, \textbf{ dis} $\ast$display\+\_\+user, \textbf{ score} $\ast$score\+\_\+user)
\begin{DoxyCompactList}\small\item\em La fonction permet de faire la boucle de jeu. \end{DoxyCompactList}\item
int \textbf{ in\+Game\+Loop} (char $\ast$$\ast$tab2d, \textbf{ vect} $\ast$dim\+\_\+tab, \textbf{ vect} $\ast$player\+Pos, \textbf{ vect} $\ast$targets, int nbr\+\_\+targets, \textbf{ dis} $\ast$display\+\_\+user, \textbf{ score} $\ast$score\+\_\+user, bool menu)
\begin{DoxyCompactList}\small\item\em La fonction permet de faire la boucle de jeu et le menu. \end{DoxyCompactList}\item
bool \textbf{ is\+Win} (char $\ast$$\ast$tab2d, \textbf{ vect} $\ast$targets, int nbr\+\_\+targets)
\begin{DoxyCompactList}\small\item\em Cette fonction verrifie si la partie est gagnante. \end{DoxyCompactList}\item
bool \textbf{ islose} (char $\ast$$\ast$tab2d, const int N)
@@ -44,7 +40,14 @@ int {\bfseries length\+Vect} (\textbf{ vect} vector)
bool \textbf{ block\+Box} (char $\ast$$\ast$tab2d, \textbf{ vect} box\+\_\+coor)
\begin{DoxyCompactList}\small\item\em La fonction permet de savoir si une boite est dans une situation ou le joueur ne poura pas la debloqué. \end{DoxyCompactList}\item
char $\ast$ \textbf{ time\+To\+Text} (time\+\_\+t time)
\begin{DoxyCompactList}\small\item\em Cette fonction renvois transforme le forma time en texte. (min\+:sec) \end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{DoxyCompactList}\small\item\em Cette fonction renvois transforme le forma time en texte. (min\+:sec) \end{DoxyCompactList}\item
void \textbf{ null\+Score} (\textbf{ score} $\ast$player\+\_\+score)
\begin{DoxyCompactList}\small\item\em Mets à 0 le score. \end{DoxyCompactList}\item
void \textbf{ win\+Or\+Lose\+Loop} (\textbf{ dis} $\ast$display\+\_\+user, \textbf{ score} $\ast$score\+\_\+user, bool win)
\begin{DoxyCompactList}\small\item\em Fonction de loop pour la win ou la lose. \end{DoxyCompactList}\item
\label{function_8c_aeac9c46be252cd970406e3a2391b8e8c}
unsigned int {\bfseries score\+Calculator} (\textbf{ score} $\ast$score\+\_\+user, bool win)
\end{DoxyCompactItemize}
\doxysubsection{Description détaillée}
@@ -71,8 +74,7 @@ La fonction permet de savoir si une boite est dans une situation ou le joueur ne
\begin{DoxyReturn}{Renvoie}
True si la la boite est bloquer, sinon false.
\end{DoxyReturn}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
\nopagebreak
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -80,13 +82,7 @@ Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
\end{center}
\end{figure}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=321pt]{function_8c_ac51249b2f7941ca06e6a614e071dd444_icgraph}
\end{center}
\end{figure}
% FIG 1
\index{function.c@{function.c}!canIGoDirection@{canIGoDirection}}
\index{canIGoDirection@{canIGoDirection}!function.c@{function.c}}
\doxysubsubsection{canIGoDirection()}
@@ -105,39 +101,35 @@ La fontction permet de savoir si le joueur peut ce deplacer dans une direction.
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
0 Si c\textquotesingle{}est un mur devant le joueur, 1 si c\textquotesingle{}est vide devant le joueur, 2 si c\textquotesingle{}est une boite mais qu\textquotesingle{}on peux la pousser ,3 si le joueur pousse une boite sur un point d\textquotesingle{}interer, 4 si le joueur bouge sur un point d\textquotesingle{}interer, 5 si le joueur peux pousser une boite mais le joueur se place sur un point d\textquotesingle{}interer et 6 si le joeuur pousse une boite sur un point d\textquotesingle{}interer et que le joueu est aussi sur un point d\textquotesingle{}interer.
0 Si c\textquotesingle{}est un mur devant le joueur, 1 si c\textquotesingle{}est vide devant le joueur, 2 si c\textquotesingle{}est une boite mais qu\textquotesingle{}on peux la pousser ,3 si le joueur pousse une boite sur un point d\textquotesingle{}interer, 4 si le joueur bouge sur un point d\textquotesingle{}interer, 5 si le joueur peux pousser une boite mais le joueur se place sur un point d\textquotesingle{}interer et 6 si le joueur pousse une boite sur un point d\textquotesingle{}interer et que le joueur est aussi sur un point d\textquotesingle{}interer. 7 si value\+Of\+NCase est un bouton.
\end{DoxyReturn}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=349pt]{function_8c_a76df2bc0c692d3397837706a6852ac36_icgraph}
\end{center}
\end{figure}
% FIG 2
\index{function.c@{function.c}!creatArea2D@{creatArea2D}}
\index{creatArea2D@{creatArea2D}!function.c@{function.c}}
\doxysubsubsection{creatArea2D()}
{\footnotesize\ttfamily \label{function_8c_af81182d12b72ee349a71d6685217b097}
char $\ast$$\ast$ creat\+Area2D (\begin{DoxyParamCaption}\item[{const unsigned int}]{N}{}\end{DoxyParamCaption})}
{\footnotesize\ttfamily \label{function_8c_a1d06514900b90ce163ebe2d5aefc16db}
char $\ast$$\ast$ creat\+Area2D (\begin{DoxyParamCaption}\item[{const int}]{x}{, }\item[{const int}]{y}{}\end{DoxyParamCaption})}
Cette fonction permet de creer une liste 2D carre.
Cette fonction permet de creer une liste 2D.
\begin{DoxyParams}{Paramètres}
{\em N} & La valeur N est le nombre d\textquotesingle{}élément dans le tableau. \\
{\em x} & Nombre de ligne. \\
\hline
{\em y} & Nombre de colonne. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Le pointeur du tableau 2D carre de char (1 octet).
Le pointeur du tableau 2D de char (1 octet).
\end{DoxyReturn}
\index{function.c@{function.c}!free2D@{free2D}}
\index{free2D@{free2D}!function.c@{function.c}}
\doxysubsubsection{free2D()}
{\footnotesize\ttfamily \label{function_8c_af19c482f0f97b30cbb0253356ed1724b}
void free2D (\begin{DoxyParamCaption}\item[{char $\ast$$\ast$}]{tab}{, }\item[{int}]{N}{}\end{DoxyParamCaption})}
{\footnotesize\ttfamily \label{function_8c_a9011ea69a97e2101aa9bcc52cc60d4ce}
void free2D (\begin{DoxyParamCaption}\item[{char $\ast$$\ast$}]{tab}{, }\item[{int}]{x}{}\end{DoxyParamCaption})}
@@ -147,7 +139,7 @@ Cette fontion permet de liberer l\textquotesingle{}espace tu tableau 2D de char.
\begin{DoxyParams}{Paramètres}
{\em tab} & Le tableau 2D. \\
\hline
{\em N} & Le nombre d\textquotesingle{}éléments. \\
{\em x} & Le nombre de ligne. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
@@ -156,12 +148,12 @@ Void.
\index{function.c@{function.c}!inGameLoop@{inGameLoop}}
\index{inGameLoop@{inGameLoop}!function.c@{function.c}}
\doxysubsubsection{inGameLoop()}
{\footnotesize\ttfamily \label{function_8c_a2387ddb7cde4f9d45198b0c131a60878}
void in\+Game\+Loop (\begin{DoxyParamCaption}\item[{char $\ast$$\ast$}]{tab2d}{, }\item[{int}]{N}{, }\item[{\textbf{ vect} $\ast$}]{player\+Pos}{, }\item[{\textbf{ vect} $\ast$}]{targets}{, }\item[{int}]{nbr\+\_\+targets}{, }\item[{\textbf{ dis} $\ast$}]{display\+\_\+user}{, }\item[{\textbf{ score} $\ast$}]{score\+\_\+user}{}\end{DoxyParamCaption})}
{\footnotesize\ttfamily \label{function_8c_a7f8e67bce9078c159778bbe2f57e9d2f}
int in\+Game\+Loop (\begin{DoxyParamCaption}\item[{char $\ast$$\ast$}]{tab2d}{, }\item[{\textbf{ vect} $\ast$}]{dim\+\_\+tab}{, }\item[{\textbf{ vect} $\ast$}]{player\+Pos}{, }\item[{\textbf{ vect} $\ast$}]{targets}{, }\item[{int}]{nbr\+\_\+targets}{, }\item[{\textbf{ dis} $\ast$}]{display\+\_\+user}{, }\item[{\textbf{ score} $\ast$}]{score\+\_\+user}{, }\item[{bool}]{menu}{}\end{DoxyParamCaption})}
La fonction permet de faire la boucle de jeu.
La fonction permet de faire la boucle de jeu et le menu.
\begin{DoxyParams}{Paramètres}
@@ -179,18 +171,14 @@ La fonction permet de faire la boucle de jeu.
\hline
{\em score\+\_\+user} & Toute les données nécessaire pour calculer le score fini du joueur. \\
\hline
{\em menu} & True si c\textquotesingle{}est la loop du menu. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Void
L\textquotesingle{}indice de la map si c\textquotesingle{}est un menu, sinon renvoie -\/1
\end{DoxyReturn}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{function_8c_a2387ddb7cde4f9d45198b0c131a60878_cgraph}
\end{center}
\end{figure}
% FIG 3
\index{function.c@{function.c}!islose@{islose}}
\index{islose@{islose}!function.c@{function.c}}
\doxysubsubsection{islose()}
@@ -205,28 +193,19 @@ La fonction renvois si la partie est perdante.
\begin{DoxyParams}{Paramètres}
{\em tab2d} & Le tableau 2d carre du plateau de jeu. \\
\hline
{\em N} & Le nombre d\textquotesingle{}éléments dans le tab2d. \\
{\em N} & Le nombre d\textquotesingle{}éléments dans le tab2d. (zone de jeu est carré) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
True si c\textquotesingle{}est perdu, false si c\textquotesingle{}est pas perdu a cette instant.
\end{DoxyReturn}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
\nopagebreak
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=312pt]{function_8c_ac155bb183b0c26d19758d8d065baf14f_cgraph}
\end{center}
\end{figure}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=229pt]{function_8c_ac155bb183b0c26d19758d8d065baf14f_icgraph}
\end{center}
\end{figure}
\index{function.c@{function.c}!isWin@{isWin}}
\index{isWin@{isWin}!function.c@{function.c}}
\doxysubsubsection{isWin()}
@@ -249,14 +228,6 @@ Cette fonction verrifie si la partie est gagnante.
\begin{DoxyReturn}{Renvoie}
True si le joueur a remplis tout les points d\textquotesingle{}interer, false si ce n\textquotesingle{}est pas le cas .
\end{DoxyReturn}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=228pt]{function_8c_a618903fbb7302d98ef0f3e2e6b35b99a_icgraph}
\end{center}
\end{figure}
\index{function.c@{function.c}!move@{move}}
\index{move@{move}!function.c@{function.c}}
\doxysubsubsection{move()}
@@ -281,8 +252,7 @@ Cette fonction effectue les deplacements du joueur et des boites en fonction de
\begin{DoxyReturn}{Renvoie}
Void
\end{DoxyReturn}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
\nopagebreak
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
@@ -290,13 +260,25 @@ Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
\end{center}
\end{figure}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=228pt]{function_8c_ac93ca31d854d91eedf3babda7511407d_icgraph}
\end{center}
\end{figure}
% FIG 4
\index{function.c@{function.c}!nullScore@{nullScore}}
\index{nullScore@{nullScore}!function.c@{function.c}}
\doxysubsubsection{nullScore()}
{\footnotesize\ttfamily \label{function_8c_a4a66f9d998c95fde67d6f89fef1fded5}
void null\+Score (\begin{DoxyParamCaption}\item[{\textbf{ score} $\ast$}]{player\+\_\+score}{}\end{DoxyParamCaption})}
Mets à 0 le score.
\begin{DoxyParams}{Paramètres}
{\em player\+\_\+score} & Le score a mettre à 0. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
void
\end{DoxyReturn}
\index{function.c@{function.c}!plusVect@{plusVect}}
\index{plusVect@{plusVect}!function.c@{function.c}}
\doxysubsubsection{plusVect()}
@@ -318,13 +300,7 @@ La fonction fait une addition de vecteur, (x1+x2, y1+y2).
vect Un vecteur de l\textquotesingle{}addition de one et two.
\end{DoxyReturn}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{function_8c_a5b10e69716d92eadf2ed0b3942cb9d4d_icgraph}
\end{center}
\end{figure}
% FIG 5
\index{function.c@{function.c}!timeToText@{timeToText}}
\index{timeToText@{timeToText}!function.c@{function.c}}
\doxysubsubsection{timeToText()}
@@ -344,10 +320,21 @@ Cette fonction renvois transforme le forma time en texte. (min\+:sec)
char Le string du texte.
\end{DoxyReturn}
Voici le graphe des appelants de cette fonction \+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=252pt]{function_8c_a51c9ba7a24383f1b20dcedfcb570aab5_icgraph}
\end{center}
\end{figure}
% FIG 6
\index{function.c@{function.c}!winOrLoseLoop@{winOrLoseLoop}}
\index{winOrLoseLoop@{winOrLoseLoop}!function.c@{function.c}}
\doxysubsubsection{winOrLoseLoop()}
{\footnotesize\ttfamily \label{function_8c_a2dc9de2f6fd2bed3619d7ce8c1f05590}
void win\+Or\+Lose\+Loop (\begin{DoxyParamCaption}\item[{\textbf{ dis} $\ast$}]{display\+\_\+user}{, }\item[{\textbf{ score} $\ast$}]{score\+\_\+user}{, }\item[{bool}]{win}{}\end{DoxyParamCaption})}
Fonction de loop pour la win ou la lose.
\begin{DoxyParams}{Paramètres}
{\em display\+\_\+user} & Tout les information du display de l\textquotesingle{}utilisateur utile. \\
\hline
{\em win} & Si on veut un affichage de victoire ou non. \\
\hline
\end{DoxyParams}