From e2e84935b9c6ecfac0904581833105b9d3481a38 Mon Sep 17 00:00:00 2001 From: Lenny FOULOU Date: Mon, 9 Dec 2024 19:28:33 +0100 Subject: [PATCH] ajout javadoc GameMouseWheelListener --- .../listeners/GameMouseWheelListener.java | 27 ++++++++++++++++--- .../listeners/GameQuitButtonListener.java | 18 ++++++++++--- 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/src/fr/monkhanny/dorfromantik/listeners/GameMouseWheelListener.java b/src/fr/monkhanny/dorfromantik/listeners/GameMouseWheelListener.java index 498d48f..853e996 100644 --- a/src/fr/monkhanny/dorfromantik/listeners/GameMouseWheelListener.java +++ b/src/fr/monkhanny/dorfromantik/listeners/GameMouseWheelListener.java @@ -4,15 +4,34 @@ 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. + */ public class GameMouseWheelListener implements MouseWheelListener { + /** + * Le plateau de jeu sur lequel les actions sont effectuées. + */ private Board board; - - // Constructeur de la classe + /** + * Constructeur pour initialiser le listener avec le plateau de jeu. + * + * @param board le plateau de jeu sur lequel effectuer les rotations de tuiles. + */ 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 + * à la tuile, dans le sens horaire ou antihoraire en fonction de la direction de la molette. + * Après la rotation, le plateau est redessiné. + * + * @param e l'événement de la molette de la souris. + */ @Override public void mouseWheelMoved(MouseWheelEvent e) { if (board.getNextTile() != null) { diff --git a/src/fr/monkhanny/dorfromantik/listeners/GameQuitButtonListener.java b/src/fr/monkhanny/dorfromantik/listeners/GameQuitButtonListener.java index 6334b2e..7e8045f 100644 --- a/src/fr/monkhanny/dorfromantik/listeners/GameQuitButtonListener.java +++ b/src/fr/monkhanny/dorfromantik/listeners/GameQuitButtonListener.java @@ -3,13 +3,25 @@ package fr.monkhanny.dorfromantik.listeners; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; - +/** + * @version 1.0 + * @author Khalid CHENOUNA + * Listener pour gérer la fermeture du jeu lorsque le bouton "Quitter" est cliqué. + * Cette classe termine l'exécution de l'application. + */ public class GameQuitButtonListener implements ActionListener { - + /** + * Constructeur par défaut pour initialiser le listener. + */ public GameQuitButtonListener() { } - + /** + * Méthode appelée lorsqu'une action est déclenchée, comme un clic sur le bouton "Quitter". + * Cette implémentation termine immédiatement l'exécution de l'application. + * + * @param e l'événement de l'action déclenchée. + */ @Override public void actionPerformed(ActionEvent e) { // Quitter