From 04c3e73b375aa71b3647d77f95b5da2fb6ee1583 Mon Sep 17 00:00:00 2001
From: Efe ERKEN <efe.erken@etu.unistra.fr>
Date: Sat, 19 Nov 2022 12:41:42 +0100
Subject: [PATCH] :memo: DOC: Add more documentation to grid.h
Added documentation to struct attributes in grid.h
---
include/grid.h | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/include/grid.h b/include/grid.h
index 7cc148a..aab89e7 100644
--- a/include/grid.h
+++ b/include/grid.h
@@ -24,13 +24,13 @@
*/
enum CaseType
{
- WALL = '#',
- BOX = '$',
- PLAYER = '@',
- GOAL = '.',
- NONE = ' ',
- BOX_GOAL = '*',
- PLAYER_GOAL = '+'
+ WALL = '#', ///< Un mur
+ BOX = '$', ///< Une boîte
+ PLAYER = '@', ///< Le joueur
+ GOAL = '.', ///< Les objectifs
+ NONE = ' ', ///< Le vide
+ BOX_GOAL = '*', ///< Superposition d'une boîte et d'un objectif
+ PLAYER_GOAL = '+' ///< Superposition d'un joueur et d'un objectif
};
/**
--
GitLab