From b2658a19bc102cef5cc66eb9ba43c6e08c51627a Mon Sep 17 00:00:00 2001
From: Bamba TOP <bamba.top@etu.u-pec.fr>
Date: Sun, 27 Oct 2024 20:17:01 +0100
Subject: [PATCH] Rajout Javadoc
---
.../java/controller/HexagonMouseListener.java | 20 +++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/src/main/java/controller/HexagonMouseListener.java b/src/main/java/controller/HexagonMouseListener.java
index cd9b3ae..038c0ba 100644
--- a/src/main/java/controller/HexagonMouseListener.java
+++ b/src/main/java/controller/HexagonMouseListener.java
@@ -6,17 +6,37 @@ import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.Set;
+
+/**
+ * La classe HexagonMouseListener gère les événements de souris pour un {@link HexagonTile}.
+ * Elle vérifie si une tuile peut être placée sur l'hexagone lorsqu'il est cliqué,
+ * en fonction des positions disponibles pour le placement.
+ */
public class HexagonMouseListener extends MouseAdapter {
private final HexagonTile hexTile;
private final TilePlacer tilePlacer;
private final Set<Point> availablePositions;
+ /**
+ * Construit un écouteur de souris pour une tuile hexagonale.
+ *
+ * @param hexTile la tuile hexagonale liée à cet écouteur
+ * @param tilePlacer l'instance de {@link TilePlacer} pour gérer le placement de tuiles
+ * @param availablePositions les positions disponibles pour le placement des tuiles
+ */
public HexagonMouseListener(HexagonTile hexTile, TilePlacer tilePlacer, Set<Point> availablePositions) {
this.hexTile = hexTile;
this.tilePlacer = tilePlacer;
this.availablePositions = availablePositions;
}
+ /**
+ * Gère l'événement de clic sur la tuile hexagonale.
+ * Si la position de l'hexagone cliqué est disponible pour le placement,
+ * elle utilise {@link TilePlacer#placeTile(Point)} pour placer une tuile.
+ *
+ * @param e l'événement de clic de souris
+ */
@Override
public void mouseClicked(MouseEvent e) {
Point position = hexTile.getPosition();