refactor Tristan

src/lecteur_pdf/Fenetre.java

@@ -47,7 +47,7 @@ public class Fenetre extends JFrame {
     private GraphicsDevice device;
 
     /**
-     * Crée une nouvelle fenêtre vide
+     * Créé une nouvelle fenêtre vide
      */
     public Fenetre() {
         super(TITRE);

src/lecteur_pdf/GestionMode.java

@@ -14,7 +14,7 @@ import java.awt.*;
 import java.util.ArrayList;
 
 /**
- * Gestionnaire de mode Synchonisé ou Séparé
+ * Gestionnaire de mode Synchronisé ou Séparé
  *
  * @author Léo Franch
  * @author Lucas Vabre
@@ -29,7 +29,7 @@ public class GestionMode {
     /** Liste les MenuItems de type NouvelleFenetre de l'application */
     private static final ArrayList<NouvelleFenetre> nouvelleFenetreList = new ArrayList<>();
 
-    /** Liste les MenuItem de type ModeSeparé de l'application */
+    /** Liste les MenuItem de type ModeSepare de l'application */
     private static final ArrayList<ModeSepare> modeSepareList = new ArrayList<>();
 
     /** Liste les MenuItem de type ModeSynchronise de l'application */

src/lecteur_pdf/Popup.java

@@ -20,7 +20,8 @@ import java.awt.*;
 public class Popup {
 
     /**
-     * Crée une nouvelle fenêtre comportant un message et deux boutons : Oui et Non
+     * Créé une nouvelle fenêtre comportant un message et
+     * deux boutons : Oui et Non
      *
      * @param parent La fenêtre parente de référence
      * @param titre Titre de la fenêtre
@@ -34,7 +35,8 @@ public class Popup {
     }
 
     /**
-     * Crée une nouvelle fenêtre comportant un message d'erreur avec un bouton OK
+     * Créé une nouvelle fenêtre comportant un message d'erreur avec un
+     * bouton OK
      *
      * @param parent La fenêtre parente de référence
      * @param titre Titre de la fenêtre

src/lecteur_pdf/SelectionnerFichier.java

@@ -36,20 +36,22 @@ public class SelectionnerFichier {
     /** Valeur du bouton Annuler */
     private static final String BOUTON_ANNULER = "Annuler";
 
-    /** indice au survol du bouton Ok */
+    /** Indice au survol du bouton Ok */
     private static final String INDICE_BOUTON_OK = "Ouvre le fichier sélectionné";
 
     /** Indice au survol du bouton Annuler */
     private static final String INDICE_BOUTON_ANNULER = "Annule la sélection";
 
     /**
-     * Méthode qui créée une fenêtre pour que l'utilisateur choisisse un fichier PDF
+     * Méthode qui créée une fenêtre pour que l'utilisateur choisisse un
+     * fichier PDF
      *
-     * @return le fichier choisi par l'utilisateur, null si aucun fichier n'est choisis
+     * @return le fichier choisi par l'utilisateur, null si aucun fichier
+     * n'est choisi
      */
     public static File ouvrirFichier(JFrame parent) {
 
-        /* Crée une fenêtre de sélection de fichier */
+        /* Créé une fenêtre de sélection de fichier */
         JFileChooser fileChooser = new JFileChooser(
             FileSystemView.getFileSystemView().getDefaultDirectory());
         fileChooser.setDialogTitle(TITRE);
@@ -59,7 +61,7 @@ public class SelectionnerFichier {
         fileChooser.setMultiSelectionEnabled(false);
         fileChooser.setAcceptAllFileFilterUsed(false);
 
-        /* Définit le texte et les tooltips des boutons */
+        /* Défini le texte et les tooltips des boutons */
         fileChooser.setApproveButtonText(BOUTON_OK);
         fileChooser.setApproveButtonToolTipText(INDICE_BOUTON_OK);
         UIManager.put("FileChooser.cancelButtonText", BOUTON_ANNULER);

src/lecteur_pdf/menuBar/MenuBar.java

@@ -25,7 +25,7 @@ import javax.swing.*;
 public class MenuBar extends JMenuBar {
 
     /**
-     * Crée une nouvelle barre de menu avec l'ensemble des menus de
+     * Créé une nouvelle barre de menu avec l'ensemble des menus de
      * l'application
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem

src/lecteur_pdf/menuBar/menu/MenuAffichage.java

@@ -1,7 +1,7 @@
 /*
  * MenuAffichage.java, 26/02/2022
- * IUT Rodez 2021-2022, INFO 2
+ * IUT Rodez 2021-2022, INFO2
- * pas de copyright, aucun droits
+ * Pas de copyright, aucun droits
  */
 
 package lecteur_pdf.menuBar.menu;
@@ -23,7 +23,7 @@ import javax.swing.*;
 public class MenuAffichage extends JMenu {
 
     /**
-     * Crée une nouvelle instance du menu d'affichage
+     * Créé une nouvelle instance du menu d'affichage
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce menu
      */

src/lecteur_pdf/menuBar/menu/MenuFichier.java

@@ -1,7 +1,7 @@
 /*
  * MenuFichier.java, 26/02/2022
- * IUT Rodez 2021-2022, INFO 2
+ * IUT Rodez 2021-2022, INFO2
- * pas de copyright, aucun droits
+ * Pas de copyright, aucun droits
  */
 
 package lecteur_pdf.menuBar.menu;
@@ -25,7 +25,7 @@ import javax.swing.*;
 public class MenuFichier extends JMenu {
 
     /**
-     * Crée une nouvelle instance du menu fichier
+     * Créé une nouvelle instance du menu fichier
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce menu
      */

src/lecteur_pdf/menuBar/menu/MenuMode.java

@@ -1,7 +1,7 @@
 /*
  * MenuMode.java, 26/02/2022
- * IUT Rodez 2021-2022, INFO 2
+ * IUT Rodez 2021-2022, INFO2
- * pas de copyright, aucun droits
+ * Pas de copyright, aucun droits
  */
 
 package lecteur_pdf.menuBar.menu;
@@ -26,14 +26,14 @@ import javax.swing.*;
 public class MenuMode extends JMenu {
 
     /**
-     * Crée une nouvelle instance du menu Mode
+     * Créé une nouvelle instance du menu Mode
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce menu
      */
     public MenuMode(Fenetre parent) {
         super("Mode");
 
-        /* Crée les différentes options */
+        /* Créé les différentes options */
         NouvelleFenetre nouvelleFenetre = new NouvelleFenetre(parent);
         ModeSepare modeSepare = new ModeSepare();
         ModeSynchronise modeSynchronise = new ModeSynchronise();

src/lecteur_pdf/menuBar/menu/MenuOptions.java

@@ -1,7 +1,7 @@
 /*
  * MenuOptions.java, 26/02/2022
- * IUT Rodez 2021-2022, INFO 2
+ * IUT Rodez 2021-2022, INFO2
- * pas de copyright, aucun droits
+ * Pas de copyright, aucun droits
  */
 
 package lecteur_pdf.menuBar.menu;
@@ -23,7 +23,7 @@ import javax.swing.*;
 public class MenuOptions extends JMenu {
 
     /**
-     * Crée une nouvelle instance du menu Options
+     * Créé une nouvelle instance du menu Options
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce menu
      */

src/lecteur_pdf/menuBar/menuItems/MenuItem.java

@@ -13,8 +13,9 @@ import javax.swing.*;
 import java.awt.event.ActionEvent;
 
 /**
- * Classe abstraite qui défini les Éléments de menu qui nécessite d'accéder à
+ * Classe abstraite qui défini les éléments de
- * leur Fenêtre parente
+ * {@link lecteur_pdf.menuBar.menu menu}
+ * qui nécessitent d'accéder à leur {@link Fenetre fenêtre} parente
  *
  * @author Léo Franch
  * @author Lucas Vabre
@@ -27,7 +28,9 @@ public abstract class MenuItem extends JMenuItem {
     final Fenetre parent;
 
     /**
-     * Crée un nouvel Élément de Menu avec un nom, une action et se référence dans la liste des raccourcis claviers
+     * 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
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      * @param name Nom de l'action

src/lecteur_pdf/menuBar/menuItems/ModeSepare.java

@@ -12,7 +12,8 @@ import lecteur_pdf.raccourcisClavier.RaccourcisClavier;
 import javax.swing.*;
 
 /**
- * Élément de Menu Mode Séparé qui permet d'activer le défilement des pages de documents en séparé
+ * Élément de {@link lecteur_pdf.menuBar.menu.MenuMode MenuMode}
+ * qui permet d'activer le défilement des pages de documents en séparé
  *
  * @author Léo Franch
  * @author Lucas Vabre
@@ -22,7 +23,8 @@ import javax.swing.*;
 public class ModeSepare extends JRadioButtonMenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Mode Séparé"
+     * Créé un nouvel élément de
+     * {@link lecteur_pdf.menuBar.menu.MenuMode MenuMode}
      */
     public ModeSepare() {
         super("Mode Séparé");

src/lecteur_pdf/menuBar/menuItems/ModeSynchronise.java

@@ -22,7 +22,8 @@ import javax.swing.*;
 public class ModeSynchronise extends JRadioButtonMenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Mode Synchronisé"
+     * Créé un nouvel élément de
+     * {@link lecteur_pdf.menuBar.menu.MenuMode MenuMode}
      */
     public ModeSynchronise() {
         super("Mode Synchronisé");

src/lecteur_pdf/menuBar/menuItems/ModifierTouches.java

@@ -22,7 +22,8 @@ import java.awt.event.ActionEvent;
 public class ModifierTouches extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Modifier Touches"
+     * 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 MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/NouvelleFenetre.java

@@ -13,7 +13,8 @@ import lecteur_pdf.GestionMode;
 import java.awt.event.ActionEvent;
 
 /**
- * É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 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
  *
  * @author Léo Franch
  * @author Lucas Vabre
@@ -23,7 +24,7 @@ import java.awt.event.ActionEvent;
 public class NouvelleFenetre extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Nouvelle Fenêtre"
+     * Créé un nouvel élément de Menu "Nouvelle Fenêtre"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */
@@ -36,7 +37,7 @@ public class NouvelleFenetre extends MenuItem {
         /* Essaye de créer une nouvelle fenêtre */
         GestionFenetre.newIhmPdf();
 
-        /* Désactive le bouton si on a atteint la limite des affichages */
+        /* Désactive le bouton si on a atteint la limite de fenêtres */
         if (GestionFenetre.FENETRE_LIST.size() == GestionFenetre.NB_MAX_PDF) GestionMode.desactiverBtnNouvelleFenetre();
     }
 }

src/lecteur_pdf/menuBar/menuItems/OuvrirFichier.java

@@ -31,7 +31,7 @@ public class OuvrirFichier extends MenuItem {
     public static final String MESSAGE_ERREUR = "Erreur : Le document n'as pas pu être chargé";
 
     /**
-     *  Crée un nouvel Élément de Menu "Ouvrir Fichier"
+     * Créé un nouvel élément de Menu "Ouvrir Fichier"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/PageEntiere.java

@@ -20,7 +20,7 @@ import java.awt.event.ActionEvent;
  */
 public class PageEntiere extends MenuItem {
     /**
-     * Crée un nouvel Élément de Menu PageEntiere
+     * Créé un nouvel élément de Menu PageEntiere
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/PagePrecedente.java

@@ -25,7 +25,7 @@ import java.awt.event.ActionEvent;
 public class PagePrecedente extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu PagePrecedente
+     * Créé un nouvel élément de Menu PagePrecedente
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce
      *               MenuItem

src/lecteur_pdf/menuBar/menuItems/PageSuivante.java

@@ -24,7 +24,7 @@ import java.awt.event.ActionEvent;
 public class PageSuivante extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Page Suivante"
+     * Créé un nouvel Élément de Menu "Page Suivante"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce
      *               MenuItem

src/lecteur_pdf/menuBar/menuItems/PleinEcran.java

@@ -21,7 +21,7 @@ import java.awt.event.ActionEvent;
 public class PleinEcran extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu PleinEcran
+     * Créé un nouvel élément de Menu PleinEcran
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/PleineLargeur.java

@@ -24,7 +24,7 @@ public class PleineLargeur extends MenuItem {
 
 
     /**
-     * Crée un nouvel Élément de Menu "Pleine Largeur"
+     * Créé un nouvel élément de Menu "Pleine Largeur"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce
      *               MenuItem

src/lecteur_pdf/menuBar/menuItems/Quitter.java

@@ -24,7 +24,7 @@ import java.awt.event.ActionEvent;
 public class Quitter extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Quitter"
+     * Créé un nouvel élément de Menu "Quitter"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/ZoomDefaut.java

@@ -21,7 +21,7 @@ import java.awt.event.ActionEvent;
 public class ZoomDefaut extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Zoom 100%"
+     * Créé un nouvel élément de Menu "Zoom 100%"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/ZoomMoins.java

@@ -21,7 +21,7 @@ import java.awt.event.ActionEvent;
 public class ZoomMoins extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Zoom 50%"
+     * Créé un nouvel élément de Menu "Zoom 50%"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/menuBar/menuItems/ZoomPlus.java

@@ -21,7 +21,7 @@ import java.awt.event.ActionEvent;
 public class ZoomPlus extends MenuItem {
 
     /**
-     * Crée un nouvel Élément de Menu "Zoom 150%"
+     * Créé un nouvel élément de Menu "Zoom 150%"
      *
      * @param parent Référence de la fenêtre qui possède l'instance de ce MenuItem
      */

src/lecteur_pdf/pdf/DocumentPdf.java

@@ -64,13 +64,16 @@ public class DocumentPdf {
     }
 
     /**
-     * Crée une image de la page voulue
+     * Créé une image de la page voulue
      *
-     * @param pageIndex Numero de la page désirée (compris entre 0 et le nombre maximal de pages)
+     * @param pageIndex Numéro de la page désirée (compris entre 0 et le 
-     * @param scale Taille de la page (La qualité de l'image est amélioré suivant cette valeur)
+     *                  nombre maximal de pages)
+     * @param scale Taille de la page (La qualité de l'image est amélioré 
+     *              suivant cette valeur)
      * @return Une image de la page demandée
      * @throws IOException Si l'image de rendu n'as pas pu être créée
-     * @throws IllegalArgumentException Si le numero de page est invalide (n'est pas compris entre 0 et le nombre maximal de pages)
+     * @throws IllegalArgumentException Si le numero de page est invalide
+     * (n'est pas compris entre 0 et le nombre maximal de pages)
      */
     public BufferedImage renderPage(int pageIndex, float scale) throws IOException {
         if (pageIndex < 0 || pageIndex >= this.getNbPages()) {

src/lecteur_pdf/pdf/PdfPanel.java

@@ -48,7 +48,7 @@ public class PdfPanel extends JPanel {
     /** La zone de saisie du numéro de page */
     private final JTextField indexPageInput;
 
-    /** Le texte définissant le nombre max de page */
+    /** Le texte définissant le nombre max de pages */
     private final JLabel maxPageLabel;
 
     /** Element scrollable qui contiens la page */
@@ -197,7 +197,7 @@ public class PdfPanel extends JPanel {
     }
 
     /**
-     * Methode qui permet de charger un PDF dans la fenêtre courante
+     * Méthode qui permet de charger un PDF dans la fenêtre courante
      *
      * @param pdfFile Le fichier PDF à charger
      * @return true si le PDF a pu se charger, false sinon

src/lecteur_pdf/raccourcisClavier/RaccourcisClavier.java

@@ -170,7 +170,7 @@ public class RaccourcisClavier extends JFrame {
     }
 
     /**
-     * Ecrit dans le fichier de sauvegarde la HashMap des raccourcis
+     * Écrit dans le fichier de sauvegarde la HashMap des raccourcis
      */
     public static void sauvegarderRaccourcis() {
         try {
@@ -181,7 +181,7 @@ public class RaccourcisClavier extends JFrame {
 
             oos.close();
             fos.close();
-            System.out.println("Sauvegardé avec succes");
+            System.out.println("Sauvegardé avec succès");
         } catch (IOException e) {
             e.printStackTrace();
         }