javadoc enums

This commit is contained in:
2024-12-07 19:22:51 +01:00
parent 39fd0ff7f0
commit cd22460ab8
5 changed files with 224 additions and 74 deletions

View File

@@ -5,9 +5,35 @@ import java.io.IOException;
import java.awt.Font; import java.awt.Font;
import java.awt.FontFormatException; import java.awt.FontFormatException;
/**
* Enumération représentant les différentes polices utilisées dans l'application.
* Les valeurs de l'énumération sont : TITLE, BUTTON et SCORE, chacune correspondant à un style de police spécifique.
* Cette classe permet de récupérer le chemin d'accès aux fichiers de police et de charger une police à une taille donnée.
*
* @version 1.0
* @author Lenny FOULOU
*/
public enum Fonts { public enum Fonts {
TITLE, BUTTON, SCORE; /**
* Police utilisée pour les titres.
*/
TITLE,
/**
* Police utilisée pour les boutons.
*/
BUTTON,
/**
* Police utilisée pour les scores.
*/
SCORE;
/**
* Récupère le chemin du fichier de police correspondant à l'énumération.
*
* @return Le chemin du fichier de police
*/
public String getFontPath() { public String getFontPath() {
switch (this) { switch (this) {
case TITLE: case TITLE:
@@ -21,6 +47,13 @@ public enum Fonts {
} }
} }
/**
* Charge la police correspondante à l'énumération et ajuste sa taille.
* Si une erreur se produit lors du chargement de la police, une police de secours (Arial) est utilisée.
*
* @param size La taille souhaitée de la police
* @return L'objet Font correspondant à l'énumération et à la taille donnée
*/
public Font getFont(float size) { public Font getFont(float size) {
try { try {
switch (this) { switch (this) {

View File

@@ -1,9 +1,49 @@
package fr.monkhanny.dorfromantik.enums; package fr.monkhanny.dorfromantik.enums;
/**
* Enumération représentant les différentes images utilisées dans l'application.
* Chaque valeur de l'énumération correspond à une image spécifique (icônes et gifs).
* Cette classe permet de récupérer le chemin d'accès aux fichiers d'images associés.
*
* @version 1.0
* @author Lenny FOULOU
*/
public enum Images { public enum Images {
SETTINGS_ICON, EXIT_ICON, TUTORIAL_GIF1, TUTORIAL_GIF2, TUTORIAL_GIF3, TUTORIAL_GIF4; /**
* Icône des paramètres.
*/
SETTINGS_ICON,
/**
* Icône de sortie.
*/
EXIT_ICON,
/**
* Gif de la première étape du tutoriel.
*/
TUTORIAL_GIF1,
/**
* Gif de la deuxième étape du tutoriel.
*/
TUTORIAL_GIF2,
/**
* Gif de la troisième étape du tutoriel.
*/
TUTORIAL_GIF3,
/**
* Gif de la quatrième étape du tutoriel.
*/
TUTORIAL_GIF4;
/**
* Récupère le chemin du fichier d'image correspondant à l'énumération.
*
* @return Le chemin du fichier d'image
*/
public String getImagePath() { public String getImagePath() {
switch (this) { switch (this) {
case SETTINGS_ICON: case SETTINGS_ICON:

View File

@@ -1,8 +1,24 @@
package fr.monkhanny.dorfromantik.enums; package fr.monkhanny.dorfromantik.enums;
/**
* Enumération représentant les différentes musiques utilisées dans l'application.
* Chaque valeur de l'énumération correspond à une musique spécifique.
* Cette classe permet de récupérer le chemin d'accès au fichier de musique associé.
*
* @version 1.0
* @author Lenny FOULOU
*/
public enum Musics { public enum Musics {
/**
* Musique du menu principal.
*/
MAIN_MENU_MUSIC; MAIN_MENU_MUSIC;
/**
* Récupère le chemin du fichier de musique correspondant à l'énumération.
*
* @return Le chemin du fichier de musique
*/
public String getSoundsPath() { public String getSoundsPath() {
switch (this) { switch (this) {
case MAIN_MENU_MUSIC: case MAIN_MENU_MUSIC:

View File

@@ -1,8 +1,29 @@
package fr.monkhanny.dorfromantik.enums; package fr.monkhanny.dorfromantik.enums;
/**
* Enumération représentant les différents effets sonores utilisés dans l'application.
* Chaque valeur de l'énumération correspond à un effet sonore spécifique.
* Cette classe permet de récupérer le chemin d'accès au fichier sonore associé.
*
* @version 1.0
* @author Lenny FOULOU
*/
public enum Sounds { public enum Sounds {
SOUNDS1, SOUNDS2; /**
* Effet sonore 1.
*/
SOUNDS1,
/**
* Effet sonore 2.
*/
SOUNDS2;
/**
* Récupère le chemin du fichier sonore correspondant à l'énumération.
*
* @return Le chemin du fichier sonore
*/
public String getSoundsPath() { public String getSoundsPath() {
switch (this) { switch (this) {
case SOUNDS1: case SOUNDS1:

View File

@@ -1,10 +1,50 @@
package fr.monkhanny.dorfromantik.enums; package fr.monkhanny.dorfromantik.enums;
/**
* Enumération représentant les différentes orientations possibles pour une tuile dans le jeu.
* Chaque orientation est définie par une direction cardinal ou intercardinale.
*
* @version 1.0
* @author Lenny FOULOU
*/
public enum TileOrientation { public enum TileOrientation {
NORTH, NORTH_EAST, SOUTH_EAST, SOUTH, SOUTH_WEST, NORTH_WEST; /**
* Orientation vers le nord.
*/
NORTH,
/**
* Orientation vers le nord-est.
*/
NORTH_EAST,
/**
* Orientation vers le sud-est.
*/
SOUTH_EAST,
/**
* Orientation vers le sud.
*/
SOUTH,
/**
* Orientation vers le sud-ouest.
*/
SOUTH_WEST,
/**
* Orientation vers le nord-ouest.
*/
NORTH_WEST;
/**
* Retourne l'orientation opposée à celle-ci.
* Par exemple, si l'orientation actuelle est NORTH, l'orientation opposée sera SOUTH.
*
* @return L'orientation opposée.
* @throws IllegalArgumentException Si l'orientation est inconnue.
*/
public TileOrientation oppositeOrientation() { public TileOrientation oppositeOrientation() {
switch (this) { switch (this) {
case NORTH: case NORTH: