From b597a2ac2d3d2ed430d991225ccc3869b7b22f82 Mon Sep 17 00:00:00 2001 From: Moncef STITI Date: Tue, 10 Dec 2024 14:04:32 +0100 Subject: [PATCH] ajout de la documentation Javadoc pour les packages de l'application --- .../dorfromantik/components/package-info.java | 10 ++++++++++ .../dorfromantik/controller/package-info.java | 10 ++++++++++ .../monkhanny/dorfromantik/enums/package-info.java | 11 +++++++++++ .../monkhanny/dorfromantik/game/package-info.java | 12 ++++++++++++ src/fr/monkhanny/dorfromantik/gui/package-info.java | 11 +++++++++++ .../dorfromantik/listeners/package-info.java | 13 +++++++++++++ src/fr/monkhanny/dorfromantik/package-info.java | 10 ++++++++++ .../monkhanny/dorfromantik/utils/package-info.java | 10 ++++++++++ 8 files changed, 87 insertions(+) create mode 100644 src/fr/monkhanny/dorfromantik/components/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/controller/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/enums/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/game/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/gui/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/listeners/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/package-info.java create mode 100644 src/fr/monkhanny/dorfromantik/utils/package-info.java diff --git a/src/fr/monkhanny/dorfromantik/components/package-info.java b/src/fr/monkhanny/dorfromantik/components/package-info.java new file mode 100644 index 0000000..b0235d9 --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/components/package-info.java @@ -0,0 +1,10 @@ +/** + * Ce package contient les composants de l'application. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.components.Button + * @see fr.monkhanny.dorfromantik.components.Title + */ +package fr.monkhanny.dorfromantik.components; diff --git a/src/fr/monkhanny/dorfromantik/controller/package-info.java b/src/fr/monkhanny/dorfromantik/controller/package-info.java new file mode 100644 index 0000000..8e0295c --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/controller/package-info.java @@ -0,0 +1,10 @@ +/** + * Ce package contient les classes qui gèrent les contrôleurs de l'application. + * Les classes de ce package sont responsables de la gestion des événements et de la communication entre les différentes parties de l'application. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.controller.GameModeController + */ +package fr.monkhanny.dorfromantik.controller; diff --git a/src/fr/monkhanny/dorfromantik/enums/package-info.java b/src/fr/monkhanny/dorfromantik/enums/package-info.java new file mode 100644 index 0000000..6b1c288 --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/enums/package-info.java @@ -0,0 +1,11 @@ +/** + * Ce package contient les énumérations utilisées dans l'application. + * Les énumérations de ce package sont utilisées pour définir des constantes et des types de données spécifiques. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.enums.Biome + * @see fr.monkhanny.dorfromantik.enums.TileOrientation + */ +package fr.monkhanny.dorfromantik.enums; diff --git a/src/fr/monkhanny/dorfromantik/game/package-info.java b/src/fr/monkhanny/dorfromantik/game/package-info.java new file mode 100644 index 0000000..8b30131 --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/game/package-info.java @@ -0,0 +1,12 @@ +/** + * Ce package contient les classes qui gèrent le jeu Dorfromantik. + * Les classes de ce package sont responsables de la logique du jeu et de la gestion des parties et du score. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.game.Board + * @see fr.monkhanny.dorfromantik.game.Game + * @see fr.monkhanny.dorfromantik.game.Tile + */ +package fr.monkhanny.dorfromantik.game; diff --git a/src/fr/monkhanny/dorfromantik/gui/package-info.java b/src/fr/monkhanny/dorfromantik/gui/package-info.java new file mode 100644 index 0000000..7a6a20d --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/gui/package-info.java @@ -0,0 +1,11 @@ +/** + * Ce package contient les classes qui gèrent l'interface graphique de l'application. + * Les classes de ce package sont des composants graphiques qui permettent à l'utilisateur d'interagir avec l'application. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.gui.GameOver + * @see fr.monkhanny.dorfromantik.gui.MainMenu + */ +package fr.monkhanny.dorfromantik.gui; diff --git a/src/fr/monkhanny/dorfromantik/listeners/package-info.java b/src/fr/monkhanny/dorfromantik/listeners/package-info.java new file mode 100644 index 0000000..f70cd2d --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/listeners/package-info.java @@ -0,0 +1,13 @@ +/** + * Ce package contient les classes qui gèrent les événements de l'application. + * Les classes de ce package sont des écouteurs d'événements qui réagissent à des actions spécifiques de l'utilisateur. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.listeners.GameEndListener + * @see fr.monkhanny.dorfromantik.listeners.GameZoomListener + * @see fr.monkhanny.dorfromantik.listeners.MusicVolumeChangeListener + * @see fr.monkhanny.dorfromantik.listeners.TileSelectionListener + */ +package fr.monkhanny.dorfromantik.listeners; \ No newline at end of file diff --git a/src/fr/monkhanny/dorfromantik/package-info.java b/src/fr/monkhanny/dorfromantik/package-info.java new file mode 100644 index 0000000..d29c876 --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/package-info.java @@ -0,0 +1,10 @@ +/** + * Ce package contient les classes qui gèrent le jeu Dorfromantik. + * + * @since 1.0 + * @version 1.0 + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @see fr.monkhanny.dorfromantik.game.Board + * @see fr.monkhanny.dorfromantik.Main + */ +package fr.monkhanny.dorfromantik; diff --git a/src/fr/monkhanny/dorfromantik/utils/package-info.java b/src/fr/monkhanny/dorfromantik/utils/package-info.java new file mode 100644 index 0000000..a2764cd --- /dev/null +++ b/src/fr/monkhanny/dorfromantik/utils/package-info.java @@ -0,0 +1,10 @@ +/** + * Ce package contient les classes utilitaires de l'application. + * Les classes de ce package contiennent des méthodes utilitaires qui peuvent être utilisées dans plusieurs parties de l'application. + * @author Moncef STITI, Lenny FOULOU, Khalid CHENOUNA + * @version 1.0 + * @since 1.0 + * @see fr.monkhanny.dorfromantik.utils.MusicPlayer + * @see fr.monkhanny.dorfromantik.utils.Database + */ +package fr.monkhanny.dorfromantik.utils;