From 23c3897bd7083e6e4f420fff1b4ba57bc225f898 Mon Sep 17 00:00:00 2001 From: NonoL3Robot Date: Fri, 11 Mar 2022 11:45:58 +0100 Subject: [PATCH] javadoc --- .../menuBar/menuItems/MenuItem.java | 5 +-- .../menuBar/menuItems/ModifierTouches.java | 7 ++-- .../menuBar/menuItems/NouvelleFenetre.java | 17 ++++++--- .../menuBar/menuItems/OuvrirFichier.java | 35 +++++++++++++------ .../menuBar/menuItems/PageEntiere.java | 11 ++++-- .../menuBar/menuItems/PagePrecedente.java | 8 +++-- 6 files changed, 59 insertions(+), 24 deletions(-) diff --git a/src/lecteur_pdf/menuBar/menuItems/MenuItem.java b/src/lecteur_pdf/menuBar/menuItems/MenuItem.java index 1b2f5ae..c5750e0 100644 --- a/src/lecteur_pdf/menuBar/menuItems/MenuItem.java +++ b/src/lecteur_pdf/menuBar/menuItems/MenuItem.java @@ -32,8 +32,9 @@ public abstract class MenuItem extends JMenuItem { /** * Créé un nouvel élément de {@link lecteur_pdf.menuBar.menu menu} - * avec un nom, une action et se référence dans la liste des raccourcis - * claviers + * avec un nom, une action et se référence dans la liste des + * {@link lecteur_pdf.raccourcisClavier.RaccourcisClavier raccourcis + * claviers} * * @param parent Référence de la fenêtre qui possède l'instance de ce * MenuItem diff --git a/src/lecteur_pdf/menuBar/menuItems/ModifierTouches.java b/src/lecteur_pdf/menuBar/menuItems/ModifierTouches.java index e738043..17ba389 100644 --- a/src/lecteur_pdf/menuBar/menuItems/ModifierTouches.java +++ b/src/lecteur_pdf/menuBar/menuItems/ModifierTouches.java @@ -12,7 +12,9 @@ import lecteur_pdf.raccourcisClavier.RaccourcisClavier; /** * Élément de {@link lecteur_pdf.menuBar.menu.MenuOptions MenuOptions} * qui permet d'ouvrir une {@link javax.swing.JFrame fenêtre} - * pour modifier les raccourcis claviers de l'application + * pour modifier les + * {@link lecteur_pdf.raccourcisClavier.RaccourcisClavier + * raccourcis claviers} de l'application * * @author Léo Franch * @author Tristan Nogaret @@ -26,7 +28,8 @@ public class ModifierTouches extends MenuItem { * Créé un nouvel élément de * {@link lecteur_pdf.menuBar.menu.MenuOptions MenuOptions} * - * @param parent Référence de la fenêtre qui possède l'instance de ce + * @param parent Référence de la {@link Fenetre fenêtre} qui possède + * l'instance de ce * {@link lecteur_pdf.menuBar.menuItems.MenuItem MenuItem} */ public ModifierTouches(Fenetre parent) { diff --git a/src/lecteur_pdf/menuBar/menuItems/NouvelleFenetre.java b/src/lecteur_pdf/menuBar/menuItems/NouvelleFenetre.java index f931230..9364a51 100644 --- a/src/lecteur_pdf/menuBar/menuItems/NouvelleFenetre.java +++ b/src/lecteur_pdf/menuBar/menuItems/NouvelleFenetre.java @@ -11,20 +11,25 @@ import lecteur_pdf.GestionFenetre; import lecteur_pdf.GestionMode; /** - * Élément de Menu NouvelleFenetre qui permet d'ouvrir une autre fenêtre - * (pouvant contenir un PDF) si le nombre maximal de fenêtre n'est pas atteint + * Élément de {@link lecteur_pdf.menuBar.menu.MenuMode MenuMode} qui permet + * d'ouvrir une autre {@link Fenetre fenêtre} (pouvant contenir un PDF) si le + * nombre maximal de fenêtres n'est pas atteint * * @author Léo Franch * @author Tristan Nogaret * @author Lucàs Vabre * @author Noé Villeneuve + * @see MenuItem */ public class NouvelleFenetre extends MenuItem { /** - * Créé un nouvel élément de Menu "Nouvelle Fenêtre" + * Créé un nouvel élément de + * {@link lecteur_pdf.menuBar.menu.MenuMode MenuMode} * - * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem + * @param parent Référence de la {@link Fenetre fenêtre} qui possède + * l'instance de ce + * {@link lecteur_pdf.menuBar.menuItems.MenuItem MenuItem} */ public NouvelleFenetre(Fenetre parent) { super(parent, "Nouvelle Fenêtre"); @@ -36,6 +41,8 @@ public class NouvelleFenetre extends MenuItem { GestionFenetre.newIhmPdf(); /* Désactive le bouton si on a atteint la limite de fenêtres */ - if (GestionFenetre.FENETRE_LIST.size() == GestionFenetre.NB_MAX_PDF) GestionMode.desactiverBtnNouvelleFenetre(); + if (GestionFenetre.FENETRE_LIST.size() == GestionFenetre.NB_MAX_PDF) { + GestionMode.desactiverBtnNouvelleFenetre(); + } } } \ No newline at end of file diff --git a/src/lecteur_pdf/menuBar/menuItems/OuvrirFichier.java b/src/lecteur_pdf/menuBar/menuItems/OuvrirFichier.java index f849100..393b56f 100644 --- a/src/lecteur_pdf/menuBar/menuItems/OuvrirFichier.java +++ b/src/lecteur_pdf/menuBar/menuItems/OuvrirFichier.java @@ -14,25 +14,37 @@ import javax.swing.*; import java.io.File; /** - * Élément de Menu Ouvrir Fichier qui permet d'ouvrir un document + * Élément de {@link lecteur_pdf.menuBar.menu.MenuFichier MenuFichier} qui + * permet d'ouvrir un document * * @author Léo Franch * @author Tristan Nogaret * @author Lucàs Vabre * @author Noé Villeneuve + * @see MenuItem */ public class OuvrirFichier extends MenuItem { - /** Titre de la popup d'erreur lors d'une erreur d'ouverture de fichier */ + /** + * Titre de la {@link lecteur_pdf.Popup popup} d'erreur lors d'une erreur + * d'ouverture de fichier + */ public static final String TITRE_ERREUR = "Erreur"; - /** Message de la popup d'erreur lors d'une erreur d'ouverture de fichier */ - public static final String MESSAGE_ERREUR = "Erreur : Le document n'as pas pu être chargé"; + /** + * Message de la {@link lecteur_pdf.Popup popup} d'erreur lors d'une + * erreur d'ouverture de fichier + */ + public static final String MESSAGE_ERREUR + = "Erreur : Le document n'as pas pu être chargé"; /** - * Créé un nouvel élément de Menu "Ouvrir Fichier" + * Créé un nouvel élément de + * {@link lecteur_pdf.menuBar.menu.MenuFichier MenuFichier} * - * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem + * @param parent Référence de la {@link Fenetre fenêtre} qui possède + * l'instance de ce + * {@link lecteur_pdf.menuBar.menuItems.MenuItem MenuItem} */ public OuvrirFichier(Fenetre parent) { super(parent, "Ouvrir"); @@ -41,9 +53,10 @@ public class OuvrirFichier extends MenuItem { @Override protected void action() { - int valide = parent.getPdfPanel().isCharge() - ? Popup.OuiNonPopup(parent, FermerFichier.TITRE, FermerFichier.MESSAGE) - : JOptionPane.YES_OPTION; + int valide = parent.getPdfPanel().isCharge() ? Popup.OuiNonPopup(parent, + FermerFichier.TITRE, + FermerFichier.MESSAGE) + : JOptionPane.YES_OPTION; if (valide == JOptionPane.YES_OPTION) { /* On charge le fichier si c'est possible */ @@ -58,7 +71,9 @@ public class OuvrirFichier extends MenuItem { if (parent.getPdfPanel().chargerPdf(fichier)) { parent.setTitle(Fenetre.TITRE + " - " + fichier.getName()); parent.pack(); - } else Popup.errorPopup(parent, TITRE_ERREUR, MESSAGE_ERREUR); + } else { + Popup.errorPopup(parent, TITRE_ERREUR, MESSAGE_ERREUR); + } } } } diff --git a/src/lecteur_pdf/menuBar/menuItems/PageEntiere.java b/src/lecteur_pdf/menuBar/menuItems/PageEntiere.java index a6186eb..6f8551b 100644 --- a/src/lecteur_pdf/menuBar/menuItems/PageEntiere.java +++ b/src/lecteur_pdf/menuBar/menuItems/PageEntiere.java @@ -9,18 +9,23 @@ package lecteur_pdf.menuBar.menuItems; import lecteur_pdf.Fenetre; /** - * Élément de Menu Page Entière qui permet d'afficher l'intégralité du document courant verticalement + * Élément de {@link lecteur_pdf.menuBar.menu.MenuAffichage MenuAffichage} + * qui permet d'afficher l'intégralité du document courant verticalement * * @author Léo Franch * @author Tristan Nogaret * @author Lucàs Vabre * @author Noé Villeneuve + * @see MenuItem */ public class PageEntiere extends MenuItem { /** - * Créé un nouvel élément de Menu PageEntiere + * Créé un nouvel élément de + * {@link lecteur_pdf.menuBar.menu.MenuAffichage MenuAffichage} * - * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem + * @param parent Référence de la {@link Fenetre fenêtre} qui possède + * l'instance de ce + * {@link lecteur_pdf.menuBar.menuItems.MenuItem MenuItem} */ public PageEntiere(Fenetre parent) { super(parent, "Page Entière"); diff --git a/src/lecteur_pdf/menuBar/menuItems/PagePrecedente.java b/src/lecteur_pdf/menuBar/menuItems/PagePrecedente.java index 7c06ac7..204a3e4 100644 --- a/src/lecteur_pdf/menuBar/menuItems/PagePrecedente.java +++ b/src/lecteur_pdf/menuBar/menuItems/PagePrecedente.java @@ -11,13 +11,17 @@ import lecteur_pdf.GestionFenetre; import lecteur_pdf.GestionMode; /** - * Élément de Menu PagePrecedente qui permet d'afficher la page précédente du - * document courant (ou les pages précédentes si le mode Synchronisé est activé) + * Élément de {@link lecteur_pdf.menuBar.menu.MenuAffichage MenuAffichage} + * qui permet d'afficher la page précédente du document courant (ou les pages + * précédentes si le + * {@link lecteur_pdf.menuBar.menuItems.ModeSynchronise mode Synchronisé} est + * activé) * * @author Léo Franch * @author Tristan Nogaret * @author Lucàs Vabre * @author Noé Villeneuve + * @see MenuItem */ public class PagePrecedente extends MenuItem {