From f96ba9257c4ab51b105cb00beab6f37a14c68ae1 Mon Sep 17 00:00:00 2001
From: llebasca <llebasca@insa-rennes.fr>
Date: Thu, 25 Feb 2021 14:52:06 +0100
Subject: [PATCH] DS.h with documentation
---
GAME/include/DS.h | 20 ++++++++++++++++++--
1 file changed, 18 insertions(+), 2 deletions(-)
diff --git a/GAME/include/DS.h b/GAME/include/DS.h
index b866260..bc3514e 100644
--- a/GAME/include/DS.h
+++ b/GAME/include/DS.h
@@ -2,12 +2,28 @@
// Created by Lucile on 18/02/2021.
*/
+/*!
+ * \file DS.h
+ * \brief Header DS
+ * \authors Lucile
+ * \version 1
+ * \date 25/02/2021
+ *
+ * DS structure definiton.
+ *
+ */
+
#ifndef INSAGAME_DS_H
#define INSAGAME_DS_H
+/*!
+ * \struct DS
+ * \brief DS structure
+ */
+
struct DS {
- int door;
- char * image_DS;
+ int door; /**< Integer representing the door number i.e. the DS location. */
+ char * image_DS; /**< Source image of the DS. */
};
#endif /*INSAGAME_DS_H*/
--
GitLab