correction bug javadoc

This commit is contained in:
Lenny FOULOU
2024-12-10 17:28:22 +01:00
parent c9bbebf500
commit 9f8ae9053e
11 changed files with 34 additions and 6 deletions

View File

@@ -9,6 +9,7 @@ import java.awt.event.ActionListener;
/**
* Listener pour gérer le bouton de fermeture dans la fenêtre des paramètres.
* Lors de l'action, le menu principal est réaffiché et la fenêtre des paramètres est cachée.
*
* @version 1.0
* @author Khalid CHENOUNA
*/

View File

@@ -10,6 +10,7 @@ import javax.swing.*;
/**
* Listener pour gérer la fermeture d'une fenêtre secondaire et réafficher le menu principal.
* Lorsque la fenêtre surveillée est fermée, ce listener rend visible le menu principal
*
* et cache la fenêtre en cours.
* @version 1.0
* @author Khalid CHENOUNA

View File

@@ -10,6 +10,7 @@ import fr.monkhanny.dorfromantik.Options;
* Listener pour gérer la fermeture du menu d'échappement (pause).
* Lorsque la fenêtre du menu d'échappement est fermée, ce listener met à jour l'état du jeu
* pour indiquer qu'il n'est plus en pause.
*
* @version 1.0
* @author Moncef STITI
*/

View File

@@ -10,6 +10,7 @@ import java.awt.event.KeyEvent;
* Listener pour gérer les touches fléchées permettant de déplacer le plateau de jeu.
* Cette classe intercepte les événements de clavier pour déplacer le plateau dans les
* directions haut, bas, gauche et droite en fonction des flèches appuyées.
*
* @version 1.0
* @author Moncef STITI
*/

View File

@@ -9,6 +9,7 @@ import javax.swing.JFrame;
/**
* Listener pour gérer le clic sur le bouton de retour au menu principal dans le jeu.
* Cette classe cache la fenêtre actuelle du jeu et réinitialise l'état du jeu en appelant la méthode `Main.resetGame`.
*
* @version 1.0
* @author Moncef STITI
*/

View File

@@ -10,6 +10,7 @@ import fr.monkhanny.dorfromantik.gui.GameModeSelectionPanel;
* Listener pour gérer les clics sur le bouton de filtrage dans le panneau de sélection du mode de jeu.
* Cette classe permet de réinitialiser la page de sélection à la première page lors de l'application d'un filtre
* et de charger les séries correspondantes à cette page.
*
* @version 1.0
* @author Lenny FOULOU
*/

View File

@@ -13,18 +13,22 @@ import fr.monkhanny.dorfromantik.utils.MusicPlayer;
* Listener pour ajouter un effet visuel et sonore lors du survol et du clic sur un bouton.
* Cette classe change la couleur d'arrière-plan du bouton lorsqu'il est survolé, cliqué ou relâché,
* et joue un son lors du survol.
*
* @version 1.0
* @author Lenny FOULOU, Khalid Chenouna
*/
public class GameModeHoverEffectMouseListener extends MouseAdapter {
/**
* La couleur d'arrière-plan par défaut du bouton.
*/
private Color defaultColor;
/**
* La couleur d'arrière-plan lorsque le bouton est survolé.
*/
private Color hoverColor;
/**
* La couleur d'arrière-plan lorsque le bouton est cliqué.
*/

View File

@@ -7,14 +7,17 @@ import fr.monkhanny.dorfromantik.gui.GameModeSelectionPanel;
/**
* Listener pour gérer les clics sur le bouton "Suivant" dans le panneau de sélection du mode de jeu.
* Cette classe permet de naviguer vers la page suivante des séries disponibles dans le panneau.
*
* @version 1.0
* @author Lenny FOULOU
*/
public class GameModeNextButtonActionListener implements ActionListener {
/**
* Le panneau de sélection du mode de jeu.
*/
private GameModeSelectionPanel panel;
/**
* Constructeur pour initialiser le listener avec le panneau de sélection du mode de jeu.
*
@@ -23,6 +26,7 @@ public class GameModeNextButtonActionListener implements ActionListener {
public GameModeNextButtonActionListener(GameModeSelectionPanel panel) {
this.panel = panel;
}
/**
* Méthode appelée lorsqu'une action est déclenchée, comme un clic sur le bouton "Suivant".
* Elle passe à la page suivante et charge les séries associées à cette page.

View File

@@ -4,13 +4,16 @@ import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import fr.monkhanny.dorfromantik.gui.GameModeSelectionPanel;
/**
* @version 1.0
* @author Lenny FOULOU
* Listener pour gérer les clics sur le bouton "Précédent" dans le panneau de sélection du mode de jeu.
* Cette classe permet de naviguer vers la page précédente des séries disponibles dans le panneau.
*
* @version 1.0
* @author Lenny FOULOU
*/
public class GameModePrevButtonActionListener implements ActionListener {
/**
* Le panneau de sélection du mode de jeu.
*/
@@ -24,6 +27,7 @@ public class GameModePrevButtonActionListener implements ActionListener {
public GameModePrevButtonActionListener(GameModeSelectionPanel panel) {
this.panel = panel;
}
/**
* Méthode appelée lorsqu'une action est déclenchée, comme un clic sur le bouton "Précédent".
* Elle vérifie si la page actuelle est supérieure à 1 et, dans ce cas, passe à la page précédente

View File

@@ -3,18 +3,22 @@ package fr.monkhanny.dorfromantik.listeners;
import fr.monkhanny.dorfromantik.game.Board;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
/**
* @version 1.0
* @author Moncef STITI
* Listener pour gérer les événements de clics de souris dans le jeu.
* Cette classe permet d'appeler la méthode appropriée du plateau de jeu
* lorsqu'un clic de souris est effectué.
*
* @version 1.0
* @author Moncef STITI
*/
public class GameMouseClickListener extends MouseAdapter {
/**
* Le plateau de jeu sur lequel les clics de souris sont traités.
*/
private Board board;
/**
* Constructeur pour initialiser le listener avec le plateau de jeu.
*
@@ -23,6 +27,7 @@ public class GameMouseClickListener extends MouseAdapter {
public GameMouseClickListener(Board board) {
this.board = board;
}
/**
* Méthode appelée lorsqu'un clic de souris est détecté sur le plateau de jeu.
* Elle délègue le traitement du clic à la méthode {@code handleMouseClick} du plateau.

View File

@@ -4,18 +4,22 @@ import fr.monkhanny.dorfromantik.game.Board;
import java.awt.event.MouseWheelEvent;
import java.awt.event.MouseWheelListener;
/**
* @version 1.0
* @author Moncef STITI
* Listener pour gérer les événements de la molette de la souris dans le jeu.
* Cette classe permet de faire pivoter la prochaine tuile sélectionnée sur le plateau
* lorsque la molette de la souris est utilisée.
*
* @version 1.0
* @author Moncef STITI
*/
public class GameMouseWheelListener implements MouseWheelListener {
/**
* Le plateau de jeu sur lequel les actions sont effectuées.
*/
private Board board;
/**
* Constructeur pour initialiser le listener avec le plateau de jeu.
*
@@ -24,6 +28,7 @@ public class GameMouseWheelListener implements MouseWheelListener {
public GameMouseWheelListener(Board board) {
this.board = board;
}
/**
* Méthode appelée lorsqu'un événement de la molette de la souris est détecté.
* Si une tuile suivante existe sur le plateau, cette méthode applique une rotation