From ad62def3968dd4667178ec509243ece38715aa06 Mon Sep 17 00:00:00 2001
From: vautrin33u <vautrin33u@etu.univ-lorraine.fr>
Date: Sun, 3 Jan 2021 17:14:18 +0100
Subject: [PATCH] Modification headers

---
 Doc/html/graphisme_8h_source.html | 67 +++++++++++++++----------------
 graphisme.h                       | 34 +++++++++++++++-
 2 files changed, 66 insertions(+), 35 deletions(-)

diff --git a/Doc/html/graphisme_8h_source.html b/Doc/html/graphisme_8h_source.html
index c9d8b60..8654deb 100644
--- a/Doc/html/graphisme_8h_source.html
+++ b/Doc/html/graphisme_8h_source.html
@@ -100,43 +100,42 @@ $(function() {
 <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;};</div>
 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structtextures__s.html">textures_s</a> <a class="code" href="structtextures__s.html">textures_t</a>;</div>
 <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160; </div>
-<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160; </div>
-<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;SDL_Texture* charger_image (<span class="keyword">const</span> <span class="keywordtype">char</span>* nomfichier, SDL_Renderer* renderer);</div>
-<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160; </div>
-<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;SDL_Texture* charger_image_transparente(<span class="keyword">const</span> <span class="keywordtype">char</span>* nomfichier, SDL_Renderer* renderer, Uint8 r, Uint8 g, Uint8 b) ;</div>
-<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
-<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;SDL_Texture* charger_texte (<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structtextures__s.html#a176123cbea52b66da25aefb60f64b7b4">message</a>, SDL_Renderer* renderer, TTF_Font *font, SDL_Color color);</div>
-<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160; </div>
-<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keywordtype">void</span> render_texte(SDL_Renderer *renderer, SDL_Rect zone_texte, SDL_Texture* texte);</div>
+<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;SDL_Texture* charger_image (<span class="keyword">const</span> <span class="keywordtype">char</span>* nomfichier, SDL_Renderer* renderer);</div>
 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
-<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keywordtype">void</span> clean_textures(<a class="code" href="structtextures__s.html">textures_t</a> *textures);</div>
-<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160; </div>
-<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keywordtype">void</span> nettoyage_graphisme (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, SDL_Window *fenetre);</div>
-<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160; </div>
-<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="keywordtype">void</span> init_textures (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, TTF_Font *font);</div>
+<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;SDL_Texture* charger_image_transparente(<span class="keyword">const</span> <span class="keywordtype">char</span>* nomfichier, SDL_Renderer* renderer, Uint8 r, Uint8 g, Uint8 b) ;</div>
+<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160; </div>
+<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;SDL_Texture* charger_texte (<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structtextures__s.html#a176123cbea52b66da25aefb60f64b7b4">message</a>, SDL_Renderer* renderer, TTF_Font *font, SDL_Color color);</div>
 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160; </div>
-<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keywordtype">void</span> apply_sprite (SDL_Renderer *renderer, SDL_Texture *tex, <a class="code" href="structsprite__s.html">sprite_t</a> sprite);</div>
+<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keywordtype">void</span> render_texte(SDL_Renderer *renderer, SDL_Rect zone_texte, SDL_Texture* texte);</div>
 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160; </div>
-<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keywordtype">void</span> apply_graphics (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, <a class="code" href="structworld__s.html">world_t</a> *world);</div>
-<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160; </div>
-<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="keywordtype">void</span> apply_mobilier (SDL_Renderer* renderer, <a class="code" href="structtextures__s.html">textures_t</a>* textures, <a class="code" href="structworld__s.html">world_t</a>* world);</div>
-<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160; </div>
-<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="keywordtype">void</span> apply_texte (SDL_Renderer* renderer, <a class="code" href="structworld__s.html">world_t</a>* world, <a class="code" href="structtextures__s.html">textures_t</a>* textures);</div>
-<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160; </div>
-<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="keywordtype">void</span> apply_ingredients (SDL_Renderer* renderer, <a class="code" href="structtextures__s.html">textures_t</a>* textures, <a class="code" href="structsprite__s.html">sprite_t</a>* ingredients, <span class="keywordtype">int</span> taille_commande);</div>
-<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160; </div>
-<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="keywordtype">void</span> apply_graphics_menu (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, <a class="code" href="structmenu__s.html">menu_t</a>* <a class="code" href="structtextures__s.html#a8aa0e4f11fb509f6af5b59e7be1af96b">menu</a>);</div>
-<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160; </div>
-<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;SDL_Rect create_SDL_rect (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h);</div>
-<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160; </div>
-<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;SDL_Rect create_SDL_rect_from_texture (SDL_Texture * texture, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> h, <span class="keywordtype">int</span> w);</div>
-<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;SDL_Rect create_SDL_rect_from_sprite (<a class="code" href="structsprite__s.html">sprite_t</a> * sprite);</div>
-<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160; </div>
-<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="keywordtype">void</span> update_graphics (SDL_Renderer *renderer, <a class="code" href="structworld__s.html">world_t</a> *world, <a class="code" href="structtextures__s.html">textures_t</a> *textures);</div>
-<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160; </div>
-<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="keywordtype">void</span> apply_graphics_score(SDL_Renderer* renderer, <a class="code" href="structtextures__s.html">textures_t</a>* textures, <span class="keywordtype">int</span>* scores, <span class="keywordtype">int</span> score_actuel);</div>
-<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160; </div>
-<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="preprocessor">#endif</span></div>
+<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="keywordtype">void</span> clean_textures(<a class="code" href="structtextures__s.html">textures_t</a> *textures);</div>
+<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160; </div>
+<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="keywordtype">void</span> nettoyage_graphisme (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, SDL_Window *fenetre);</div>
+<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160; </div>
+<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="keywordtype">void</span> init_textures (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, TTF_Font *font);</div>
+<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160; </div>
+<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="keywordtype">void</span> apply_sprite (SDL_Renderer *renderer, SDL_Texture *tex, <a class="code" href="structsprite__s.html">sprite_t</a> sprite);</div>
+<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160; </div>
+<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="keywordtype">void</span> apply_graphics (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, <a class="code" href="structworld__s.html">world_t</a> *world);</div>
+<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160; </div>
+<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="keywordtype">void</span> apply_mobilier (SDL_Renderer* renderer, <a class="code" href="structtextures__s.html">textures_t</a>* textures, <a class="code" href="structworld__s.html">world_t</a>* world);</div>
+<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160; </div>
+<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="keywordtype">void</span> apply_texte (SDL_Renderer* renderer, <a class="code" href="structworld__s.html">world_t</a>* world, <a class="code" href="structtextures__s.html">textures_t</a>* textures);</div>
+<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160; </div>
+<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="keywordtype">void</span> apply_ingredients (SDL_Renderer* renderer, <a class="code" href="structtextures__s.html">textures_t</a>* textures, <a class="code" href="structsprite__s.html">sprite_t</a>* ingredients, <span class="keywordtype">int</span> taille_commande);</div>
+<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160; </div>
+<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="keywordtype">void</span> apply_graphics_menu (SDL_Renderer *renderer, <a class="code" href="structtextures__s.html">textures_t</a> *textures, <a class="code" href="structmenu__s.html">menu_t</a>* <a class="code" href="structtextures__s.html#a8aa0e4f11fb509f6af5b59e7be1af96b">menu</a>);</div>
+<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160; </div>
+<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;SDL_Rect create_SDL_rect (<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h);</div>
+<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160; </div>
+<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;SDL_Rect create_SDL_rect_from_texture (SDL_Texture * texture, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> h, <span class="keywordtype">int</span> w);</div>
+<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;SDL_Rect create_SDL_rect_from_sprite (<a class="code" href="structsprite__s.html">sprite_t</a> * sprite);</div>
+<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160; </div>
+<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="keywordtype">void</span> update_graphics (SDL_Renderer *renderer, <a class="code" href="structworld__s.html">world_t</a> *world, <a class="code" href="structtextures__s.html">textures_t</a> *textures);</div>
+<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160; </div>
+<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="keywordtype">void</span> apply_graphics_score(SDL_Renderer* renderer, <a class="code" href="structtextures__s.html">textures_t</a>* textures, <span class="keywordtype">int</span>* scores, <span class="keywordtype">int</span> score_actuel);</div>
+<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160; </div>
+<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="preprocessor">#endif</span></div>
 </div><!-- fragment --></div><!-- contents -->
 <div class="ttc" id="astructworld__s_html"><div class="ttname"><a href="structworld__s.html">world_s</a></div><div class="ttdef"><b>Definition:</b> stocks.h:28</div></div>
 <div class="ttc" id="astructtextures__s_html_a29702457ea36905e09af75a6c118784c"><div class="ttname"><a href="structtextures__s.html#a29702457ea36905e09af75a6c118784c">textures_s::titre</a></div><div class="ttdeci">SDL_Texture * titre</div><div class="ttdef"><b>Definition:</b> graphisme.h:31</div></div>
diff --git a/graphisme.h b/graphisme.h
index 466242f..8b86053 100644
--- a/graphisme.h
+++ b/graphisme.h
@@ -45,13 +45,45 @@ struct textures_s{
 
 typedef struct textures_s textures_t;
 
-
+/**
+ * @brief Charge une image sous forme de texture
+ * 
+ * @param nomfichier Emplacement du fichier (BMP)
+ * @param renderer 
+ * @return SDL_Texture* 
+ */
 SDL_Texture* charger_image (const char* nomfichier, SDL_Renderer* renderer);
 
+/**
+ * @brief Charge une image avec des éléments transparents sur une texture
+ * 
+ * @param nomfichier Emplacement du fichier
+ * @param renderer 
+ * @param r 
+ * @param g 
+ * @param b 
+ * @return SDL_Texture* 
+ */
 SDL_Texture* charger_image_transparente(const char* nomfichier, SDL_Renderer* renderer, Uint8 r, Uint8 g, Uint8 b) ;
 
+/**
+ * @brief Charge du texte sur une texture
+ * 
+ * @param message Texte à afficher
+ * @param renderer 
+ * @param font Police utilisé pour retranscrire le texte à l'écran
+ * @param color Couleur du texte
+ * @return SDL_Texture* 
+ */
 SDL_Texture* charger_texte (const char* message, SDL_Renderer* renderer, TTF_Font *font, SDL_Color color);
 
+/**
+ * @brief Appliquer le texte sur le renderer
+ * 
+ * @param renderer 
+ * @param zone_texte Zone de l'écran où faire apparaître le texte
+ * @param texte Texture correspondant au texte
+ */
 void render_texte(SDL_Renderer *renderer, SDL_Rect zone_texte, SDL_Texture* texte);
 
 /**
-- 
GitLab