Ajout de commentaire sur Menu et TestMenu

src/lecteur_pdf/menu/Menu.java

@@ -67,7 +67,7 @@ public class Menu extends JMenuBar {
         JMenuItem Fermer = new JMenuItem("Fermer");
         JMenuItem Quitter = new JMenuItem("Quitter");
 
-        // Ajoute des Listener aux JMenuItem
+        // Ajoute des actionListener aux JMenuItem
         Ouvrir.addActionListener(this::actionPerformed);
         Fermer.addActionListener(this::actionPerformed);
         Quitter.addActionListener(this::actionPerformed);
@@ -83,7 +83,7 @@ public class Menu extends JMenuBar {
                                                             KeyEvent.CTRL_DOWN_MASK);
         Quitter.setAccelerator(raccourciQuitter);
 
-        // Ajouter les éléments au menu "Fichier"
+        // Ajout des éléments au menu "Fichier"
         Fichier.add(Ouvrir);
         Fichier.add(Fermer);
         Fichier.add(Quitter);
@@ -91,7 +91,7 @@ public class Menu extends JMenuBar {
         // Ajoute le menu "Fichier" dans la liste des menus
         MENU_LIST.add(Fichier);
 
-        // Ajoute Ouvrir, Fermer et Quitter dans la liste des sous menu
+        // Ajoute Ouvrir, Fermer et Quitter dans la liste des items
         ITEM_LIST.add(Ouvrir);
         ITEM_LIST.add(Fermer);
         ITEM_LIST.add(Quitter);
@@ -100,18 +100,21 @@ public class Menu extends JMenuBar {
         this.add(Fichier);
     }
 
+/**
+ * Menu Options, pas fini, à faire dans les prochains sprints
+  */
 //    /**
 //     * Créé le menu Options et ses sous-menus
 //     */
 //    private void createMenuOptions() {
 //
-//        // Créer le Menu
+//        // Créer le Menu Options
 //        JMenu Options = new JMenu("Options");
 //
 //        // Créer l'item Préférences
 //        JMenuItem Preferences = new JMenuItem("Préférences");
 //
-//        // Ajoute des Listener aux JMenuItem
+//        // Ajout du Listener au JMenuItem
 //        Preferences.addActionListener(this::actionPerformed);
 //
 //        // Définis les raccourcis
@@ -125,7 +128,7 @@ public class Menu extends JMenuBar {
 //        // Ajoute le menu "Affichage" dans la liste des menus
 //        MENU_LIST.add(Options);
 //
-//        // Ajoute Preferences dans la liste des sous menu
+//        // Ajoute Preferences dans la liste des items
 //        ITEM_LIST.add(Preferences);
 //
 //        // Ajoute le menu à la barre de menu
@@ -140,7 +143,7 @@ public class Menu extends JMenuBar {
         // Créer le Menu Affichage
         JMenu Affichage = new JMenu("Affichage");
 
-        // Créer les items de zoom
+        // Créer les items de zoom, plein écran et affichage horizontal ou vertical
         JMenuItem PleinEcran = new JMenuItem("Mode plein écran");
         JMenuItem ZoomPlus = new JMenuItem("Zoom 150%");
         JMenuItem ZoomNeutre = new JMenuItem("Zoom 100%");
@@ -148,7 +151,7 @@ public class Menu extends JMenuBar {
         JMenuItem affichageVertical = new JMenuItem("Disposition Verticale");
         JMenuItem affichageHorizontal = new JMenuItem("Disposition Horizontale");
 
-        // Ajoute des Listener aux JMenuItem
+        // Ajoute des actionListener aux JMenuItem
         PleinEcran.addActionListener(this::actionPerformed);
         ZoomPlus.addActionListener(this::actionPerformed);
         ZoomNeutre.addActionListener(this::actionPerformed);
@@ -156,8 +159,7 @@ public class Menu extends JMenuBar {
         affichageVertical.addActionListener(this::actionPerformed);
         affichageHorizontal.addActionListener(this::actionPerformed);
 
-        // Définis les raccourcis
+        // Définis les raccourcis des différents JMenuItems
-
         KeyStroke raccourciPleinEcran = KeyStroke.getKeyStroke(KeyEvent.VK_F11,
                                                               0);
         PleinEcran.setAccelerator(raccourciPleinEcran);
@@ -171,7 +173,7 @@ public class Menu extends JMenuBar {
                                                               KeyEvent.CTRL_DOWN_MASK);
         ZoomMinus.setAccelerator(raccourciZoomMinus);
 
-        // Ajouter les éléments au menu "Affichage"
+        // Ajout des éléments au menu "Affichage"
         Affichage.add(PleinEcran);
         Affichage.addSeparator();
         Affichage.add(ZoomPlus);
@@ -184,7 +186,7 @@ public class Menu extends JMenuBar {
         // Ajoute le menu "Affichage" dans la liste des menus
         MENU_LIST.add(Affichage);
 
-        // Ajoute les JMenuItem dans la liste des sous-menus
+        // Ajoute les JMenuItem dans la liste des items
         ITEM_LIST.add(PleinEcran);
         ITEM_LIST.add(ZoomPlus);
         ITEM_LIST.add(ZoomNeutre);
@@ -211,15 +213,17 @@ public class Menu extends JMenuBar {
         final int FERMER = 0;
         final int QUITTER = 1;
 
+        /**
+         * Message sur les pop ups d'erreurs
+         */
         final String[][] POPUPS_MSG = {
             {"Fermer le PDF actuel", "Êtes-vous sûr de vouloir fermer le PDF "
                                      + "courant ?"},
             {"Quitter l'application", "Êtes-vous sûr de vouloir quitter ?"}
         };
 
-
-
         switch (choice) {
+            // Cas où l'utilisateur clique sur ouvrir
             case "Ouvrir" -> {
                 if (FENETRE.isFullscreen()) {
                     FENETRE.setFullscreen();
@@ -241,6 +245,8 @@ public class Menu extends JMenuBar {
                     }
                 }
             }
+
+            // Cas où l'utilisateur clique sur fermer
             case "Fermer" -> {
                 if (FENETRE.isFullscreen()) {
                     FENETRE.setFullscreen();
@@ -251,6 +257,8 @@ public class Menu extends JMenuBar {
                     FENETRE.setup();
                 }
             }
+
+            // Cas où l'utilisateur clique sur quitter
             case "Quitter" -> {
                 if (FENETRE.isFullscreen()) {
                     FENETRE.setFullscreen();
@@ -261,9 +269,13 @@ public class Menu extends JMenuBar {
                     System.exit(0);
                 }
             }
+
+            // Cas où l'utilisateur clique sur mode plein écran
             case "Mode plein écran" -> {
                 FENETRE.setFullscreen();
             }
+
+            // Cas où l'utilisateur clique sur zoom 150%
             case "Zoom 150%" -> {
                 try {
                     FENETRE.chargerPDF(2.0f);
@@ -271,6 +283,8 @@ public class Menu extends JMenuBar {
                     JOptionPane.showMessageDialog(FENETRE, messageErrCorrompu);
                 }
             }
+
+            // Cas où l'utilisateur clique sur zoom 100%
             case "Zoom 100%" -> {
                 try {
                     FENETRE.chargerPDF(1.0f);
@@ -278,6 +292,8 @@ public class Menu extends JMenuBar {
                     JOptionPane.showMessageDialog(FENETRE, messageErrCorrompu);
                 }
             }
+
+            // Cas où l'utilisateur clique sur zoom 50%
             case "Zoom 50%" -> {
                 try {
                     FENETRE.chargerPDF(0.5f);
@@ -285,6 +301,8 @@ public class Menu extends JMenuBar {
                     JOptionPane.showMessageDialog(FENETRE, messageErrCorrompu);
                 }
             }
+
+            // Cas où l'utilisateur clique sur dispotion verticale
             case "Disposition Verticale" -> {
                 if (FENETRE.haveDocument()) {
                     FENETRE.setAffichageVertical(true);
@@ -295,6 +313,8 @@ public class Menu extends JMenuBar {
                     }
                 }
             }
+
+            // Cas où l'utilisateur clique sur dispotion horizontale
             case "Disposition Horizontale" -> {
                 if (FENETRE.haveDocument()) {
                     FENETRE.setAffichageVertical(false);
@@ -316,7 +336,7 @@ public class Menu extends JMenuBar {
     }
 
     /**
-     * Methode qui renvoie le sous menu demandé
+     * Methode qui renvoie le sous menu demandé avec l'index adéquat
      *
      * @param index Indice du sous menu
      * @return Le sous menu demandé

tests/lecteur_pdf/menu/MenuTest.java

@@ -26,6 +26,10 @@ import static org.junit.jupiter.api.Assertions.*;
  */
 class MenuTest {
 
+    /**
+     * Classe de test de getMenuItems
+     * Teste si le getter retourne bien les MenuItems
+     */
     @Test
     void getMenuItems() {
 
@@ -39,6 +43,10 @@ class MenuTest {
         }
     }
 
+    /**
+     * Classe de test de getMenuItem
+     * Teste si le getter retourne bien le MenuItem à l'index donné
+     */
     @Test
     void getMenuItem() {
 
@@ -51,6 +59,10 @@ class MenuTest {
         }
     }
 
+    /**
+     * Classe de test Menu
+     * Main pour voir l'affichage des menus et valide le test ou non
+     */
     @Test
     void testMenu() {
         // Frame de test