ajout de la documentation Javadoc pour les packages de l'application

This commit is contained in:
2024-12-10 14:04:32 +01:00
parent b64413ea7f
commit b597a2ac2d
8 changed files with 87 additions and 0 deletions

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;

View File

@@ -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;