correction bug javadoc

This commit is contained in:
Lenny FOULOU
2024-12-10 17:47:49 +01:00
parent 9f8ae9053e
commit a5034081b0
10 changed files with 113 additions and 7 deletions

View File

@@ -16,6 +16,7 @@ import javax.swing.JFrame;
/** /**
* Classe principale du jeu * Classe principale du jeu
*
* @version 1.0 * @version 1.0
* @author Moncef STITI * @author Moncef STITI
* @see MainMenu * @see MainMenu

View File

@@ -28,24 +28,93 @@ import java.awt.*;
*/ */
public class Board extends JPanel{ public class Board extends JPanel{
/**
* Liste des tuiles présentes sur le plateau de jeu.
*/
private List<Tile> tiles; private List<Tile> tiles;
/**
* Liste des positions disponibles où une tuile peut être placée sur le plateau.
*/
private List<Point> availablePositions; private List<Point> availablePositions;
/**
* Objet de génération aléatoire utilisé pour déterminer certaines actions dans le jeu.
*/
private Random random; private Random random;
/**
* Référence au jeu en cours, permettant d'interagir avec la logique du jeu.
*/
private Game game; private Game game;
/**
* Fenêtre principale du jeu dans laquelle le plateau de jeu est affiché.
*/
private JFrame gameFrame; private JFrame gameFrame;
/**
* La tuile centrale du jeu, placée au démarrage du jeu.
*/
private Tile centralTile; private Tile centralTile;
private double zoomFactor = 1.0; // Facteur de zoom initial
private int offsetX = 0; // Décalage horizontal du plateau /**
private int offsetY = 0; // Décalage vertical du plateau * Facteur de zoom initial, utilisé pour contrôler le niveau de zoom du plateau.
*/
private double zoomFactor = 1.0;
/**
* Décalage horizontal du plateau, utilisé pour déplacer l'affichage du plateau.
*/
private int offsetX = 0;
/**
* Décalage vertical du plateau, utilisé pour déplacer l'affichage du plateau.
*/
private int offsetY = 0;
/**
* La prochaine tuile à placer sur le plateau, visible avant le placement effectif.
*/
private Tile nextTile; private Tile nextTile;
/**
* Position actuelle de la souris sur le plateau, utilisée pour placer la prochaine tuile.
*/
private Point mousePosition; private Point mousePosition;
/**
* Score actuel du joueur dans le jeu.
*/
private int currentScore; private int currentScore;
/**
* Objet représentant la base de données pour enregistrer les scores et autres informations.
*/
private Database database; private Database database;
/**
* Indicateur visuel du nombre de tuiles restantes à placer sur le plateau.
*/
private RemainingTilesIndicator remainingTilesIndicator; private RemainingTilesIndicator remainingTilesIndicator;
/**
* Menu contenant les contrôles du jeu, utilisé pour afficher ou masquer les options.
*/
private GameControlsMenu controlsMenu; private GameControlsMenu controlsMenu;
/**
* Gestionnaire de score utilisé pour mettre à jour et calculer les scores du joueur.
*/
private ScoreManager scoreManager; private ScoreManager scoreManager;
/**
* Affichage du score actuel dans le jeu.
*/
private ScoreDisplay scoreDisplay; private ScoreDisplay scoreDisplay;
// Constructeur avec seed // Constructeur avec seed
public Board(JFrame gameFrame, long seed) { public Board(JFrame gameFrame, long seed) {
this.gameFrame = gameFrame; this.gameFrame = gameFrame;

View File

@@ -10,10 +10,27 @@ import javax.swing.*;
* @author Lenny FOULOU, Khalid CHENOUNA * @author Lenny FOULOU, Khalid CHENOUNA
*/ */
public class Cell extends JComponent { public class Cell extends JComponent {
private Board board; // Le plateau de jeu auquel cette cellule appartient
public int x; // Coordonnée x du centre de la cellule /**
public int y; // Coordonnée y du centre de la cellule * Le plateau de jeu auquel cette cellule appartient.
public int radius; // Rayon de la cellule (si on parle d'un hexagone, c'est le rayon de l'hexagone) */
private Board board;
/**
* La coordonnée x du centre de la cellule.
*/
public int x;
/**
* La coordonnée y du centre de la cellule.
*/
public int y;
/**
* Le rayon de la cellule (si on parle d'un hexagone, c'est le rayon de l'hexagone).
*/
public int radius;
/** /**
* Constructeur de la classe Cell. * Constructeur de la classe Cell.

View File

@@ -16,8 +16,19 @@ import java.awt.event.ActionListener;
public class EscapeMenu extends JFrame { public class EscapeMenu extends JFrame {
/**
* Le bouton permettant de reprendre la partie en cours.
*/
private JButton resumeButton; private JButton resumeButton;
/**
* Le bouton permettant de retourner au menu principal.
*/
private JButton mainMenuButton; private JButton mainMenuButton;
/**
* Le bouton permettant d'accéder aux paramètres du jeu.
*/
private JButton settingsButton; private JButton settingsButton;
/** /**

View File

@@ -21,6 +21,7 @@ import java.util.Calendar;
* Classe représentant le panneau de sélection du mode de jeu dans l'interface graphique. * Classe représentant le panneau de sélection du mode de jeu dans l'interface graphique.
* Ce panneau permet à l'utilisateur de choisir une série de jeux à partir d'une liste paginée. * Ce panneau permet à l'utilisateur de choisir une série de jeux à partir d'une liste paginée.
* Il offre également des fonctionnalités de filtrage par dates et par créateur, ainsi qu'un champ pour entrer une seed. * Il offre également des fonctionnalités de filtrage par dates et par créateur, ainsi qu'un champ pour entrer une seed.
*
* @version 1.0 * @version 1.0
* @author Moncef STITI, Khalid CHENOUNA, Lenny FOULOU * @author Moncef STITI, Khalid CHENOUNA, Lenny FOULOU
*/ */
@@ -61,6 +62,8 @@ public class GameModeSelectionPanel extends JPanel {
/** Spinners permettant de sélectionner une plage de dates. */ /** Spinners permettant de sélectionner une plage de dates. */
private JSpinner startDateSpinner; private JSpinner startDateSpinner;
/** Spinners permettant de sélectionner une plage de dates. */
private JSpinner endDateSpinner; private JSpinner endDateSpinner;
/** Listener pour les actions des boutons. */ /** Listener pour les actions des boutons. */

View File

@@ -15,6 +15,7 @@ import java.io.IOException;
* @author Moncef STITI * @author Moncef STITI
*/ */
public class FontManager { public class FontManager {
/** /**
* Police pour les titres. * Police pour les titres.
*/ */

View File

@@ -14,6 +14,7 @@ import java.awt.Polygon;
* @author Khalid CHENOUNA * @author Khalid CHENOUNA
*/ */
public class Hexagon extends Polygon { public class Hexagon extends Polygon {
/** /**
* Angle entre deux sommets de l'hexagone * Angle entre deux sommets de l'hexagone
*/ */

View File

@@ -18,6 +18,7 @@ import fr.monkhanny.dorfromantik.enums.TileOrientation;
* @author Lenny FOULOU, Khalid CHENOUNA * @author Lenny FOULOU, Khalid CHENOUNA
*/ */
public class HexagonDrawer { public class HexagonDrawer {
/** /**
* Tuile à dessiner. * Tuile à dessiner.
*/ */

View File

@@ -12,6 +12,7 @@ import javax.imageio.ImageIO;
* @author Moncef STITI * @author Moncef STITI
*/ */
public class ImageLoader { public class ImageLoader {
/** /**
* Icône de l'application. * Icône de l'application.
*/ */

View File

@@ -18,6 +18,7 @@ import javax.sound.sampled.FloatControl;
* @version 1.0 * @version 1.0
*/ */
public class MusicPlayer { public class MusicPlayer {
/** /**
* Clip pour la musique. * Clip pour la musique.
*/ */