📝 Mise à jour de la JavaDoc

Author: MathieuSoysal

src/main/java/edt/umontp/fr/EmploiDuTemps.java

@@ -25,9 +25,9 @@
  * instance de celle-ci.
  * </p>
  * 
- * @deprecated Pour l'utilisation de celle-ci il est préférable de passer par
- *             son proxy : {@link EmploiDuTempsProxy} afin d'avoir une meilleure
- *             optimisation.
+ * @deprecated Pour l'utilisation de la class EmploiDuTemps, il est préférable
+ *             de passer par son proxy : {@link EmploiDuTempsProxy} afin d'avoir
+ *             de meilleurs temps de réponse.
  * 
  * @see InterfaceEmploiDuTemps
  * @see EmploiDuTempsProxy
@@ -133,16 +133,46 @@ public void actualiser() {
         planningEmploisDuTemps = new Planning(coursList);
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à une date
+     *
+     * @param date date pour laquelle on veut obtenir le planning
+     * @return {@code Planning} correspondant
+     * @since 1.0
+     * 
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(LocalDate date) {
         return planningEmploisDuTemps.getPlanningOf(date);
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à une date et un groupe
+     *
+     * @param date   date dont on veut obtenir le planning
+     * @param groupe groupe dont on veut obtenir le planning
+     * @return planning correspondant
+     * @since 1.0
+     * 
+     * @see Groupe
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(LocalDate date, Groupe groupe) {
         return planningEmploisDuTemps.getPlanningOf(date, groupe);
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à un groupe
+     *
+     * @param groupe groupe dont on veut obtenir le planning
+     * @return planning correspondant
+     * @since 1.0
+     * 
+     * @see Groupe
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(Groupe groupe) {
         return planningEmploisDuTemps.getPlanningOf(groupe);

src/main/java/edt/umontp/fr/EmploiDuTempsProxy.java

@@ -5,14 +5,18 @@
 import java.util.HashMap;
 
 /**
- * EmploiDuTempsProxy est un classe qui permet de proposer un proxy pour
- * l'emploi du temps
- *
- * @author emerick-biron, MathieuSoysal
- * @version 1.0
+ * <b>EmploiDuTempsProxy est la classe représentant le proxy de la class
+ * {@link EmploiDuTemps}.</b>
+ * <p>
+ * L'instance d'EmploiDuTempsProxy est caractérisé par une liste de cache.
+ * 
+ * @author emerick-biron
+ * @author MathieuSoysal
+ * @version 1.0.0
+ * @see EmploiDuTemps
  * @see InterfaceEmploiDuTemps
  */
-public class EmploiDuTempsProxy implements InterfaceEmploiDuTemps {
+public final class EmploiDuTempsProxy implements InterfaceEmploiDuTemps {
     private static EmploiDuTempsProxy singleton = null;
     @SuppressWarnings("deprecation")
     private EmploiDuTemps emploiDuTemps;
@@ -26,6 +30,10 @@ private EmploiDuTempsProxy() {
         actualiser();
     }
 
+    /**
+     * @return l'instance de {@link EmploiDuTempsProxy}.
+     * 
+     */
     public static EmploiDuTempsProxy getInstance() {
         EmploiDuTempsProxy localInstance = singleton;
         if (localInstance == null) {
@@ -39,22 +47,55 @@ public static EmploiDuTempsProxy getInstance() {
         return localInstance;
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à une date
+     *
+     * @param date date pour laquelle on veut obtenir le planning
+     * @return {@code Planning} correspondant
+     * @since 1.0
+     * 
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(LocalDate date) {
         return cacheDate.computeIfAbsent(date, k -> emploiDuTemps.getPlanningOf(k));
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à une date et un groupe
+     *
+     * @param date   date dont on veut obtenir le planning
+     * @param groupe groupe dont on veut obtenir le planning
+     * @return planning correspondant
+     * @since 1.0
+     * 
+     * @see Groupe
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(LocalDate date, Groupe groupe) {
         MultiKey<LocalDate, Groupe> multiKey = new MultiKey<>(date, groupe);
         return cacheDateGroupe.computeIfAbsent(multiKey, k -> getPlanningOf(k.key1).getPlanningOf(k.key2));
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à un groupe
+     *
+     * @param groupe groupe dont on veut obtenir le planning
+     * @return planning correspondant
+     * @since 1.0
+     * 
+     * @see Groupe
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(Groupe groupe) {
         return cacheGroupe.computeIfAbsent(groupe, k -> emploiDuTemps.getPlanningOf(k));
     }
 
+    /**
+     * Permet d'actualiser l'emploi du temps avec celui de l'ent.
+     */
     @SuppressWarnings("deprecation")
     @Override
     public void actualiser() {

src/main/java/edt/umontp/fr/Groupe.java

@@ -7,15 +7,15 @@
 
 /**
  * <b>Groupe est une enumeration qui permet de recenser les différents groupes
- * d'enseignements de l'université</b>
+ * d'élèves de l'université</b>
  * <p>
  * Une instance de groupe est caractérisé par les informations suivantes :
  * <ul>
  * <li>Un intitulé.</li>
  * <li>Un groupe parent.</li>
  * </ul>
  * <p>
- * De plus, un {@link Groupe} ne pas être instancié, il faut donc utiliser
+ * De plus, un {@link Groupe} ne pas être instancié, il faut donc passer par
  * l'enumération.
  * </p>
  * 

src/main/java/edt/umontp/fr/InterfaceEmploiDuTemps.java

@@ -11,7 +11,7 @@
 interface InterfaceEmploiDuTemps extends Planifiable {
 
     /**
-     * Permet d'actualiser l'emploi du temps
+     * Permet d'actualiser l'emploi du temps avec celui de l'ent.
      */
     public void actualiser();
 }

src/main/java/edt/umontp/fr/Planning.java

@@ -10,7 +10,6 @@
 import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
-
 /**
  * <b>Planning est la classe représentant un planning de {@link Cours} de
  * l'empois du temps de l'université.</b>
@@ -65,6 +64,15 @@ public String toString() {
         return res;
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à une date
+     *
+     * @param date date pour laquelle on veut obtenir le planning
+     * @return {@code Planning} correspondant
+     * @since 1.0
+     * 
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(LocalDate date) {
         ArrayList<Cours> result = new ArrayList<>();
@@ -83,11 +91,32 @@ public Planning getPlanningOf(LocalDate date) {
         return new Planning(result);
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à une date et un groupe
+     *
+     * @param date   date dont on veut obtenir le planning
+     * @param groupe groupe dont on veut obtenir le planning
+     * @return planning correspondant
+     * @since 1.0
+     * 
+     * @see Groupe
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(LocalDate date, Groupe groupe) {
         return getPlanningOf(date).getPlanningOf(groupe);
     }
 
+    /**
+     * Permet d'obtenir le planning correspondant à un groupe
+     *
+     * @param groupe groupe dont on veut obtenir le planning
+     * @return planning correspondant
+     * @since 1.0
+     * 
+     * @see Groupe
+     * @see Planning
+     */
     @Override
     public Planning getPlanningOf(Groupe groupe) {
         return new Planning(cours.stream().filter(x -> Groupe.unGroupeDeGroupesEstContenuDans(x.getGroupes(), groupe))