(très) légères modifications dans les commentaires et ajout de compodoc et d'un script npm dans package.json pour lancer la création automatique de la documentation

.gitignore

@@ -44,3 +44,6 @@ testem.log
 # System Files
 .DS_Store
 Thumbs.db
+
+# Documentation
+documentation/*

package.json

@@ -7,7 +7,8 @@
     "build": "ng build",
     "test": "ng test",
     "lint": "ng lint",
-    "e2e": "ng e2e"
+    "e2e": "ng e2e",
+    "compodoc": "./node_modules/.bin/compodoc -p tsconfig.json"
   },
   "private": true,
   "dependencies": {
@@ -31,9 +32,10 @@
     "@angular-devkit/build-angular": "~0.901.7",
     "@angular/cli": "~9.1.7",
     "@angular/compiler-cli": "~9.1.9",
-    "@types/node": "^12.11.1",
+    "@compodoc/compodoc": "^1.1.11",
     "@types/jasmine": "~3.5.0",
     "@types/jasminewd2": "~2.0.3",
+    "@types/node": "^12.11.1",
     "codelyzer": "^5.1.2",
     "jasmine-core": "~3.5.0",
     "jasmine-spec-reporter": "~4.2.1",

src/app/home/home-assistante/home-assistante.component.ts

@@ -18,7 +18,7 @@ import { DisplayEP } from "../../utils/displayEP";
   * Cette interface affiche la liste des EP disponibles et en cours, de les trier et de faire une recherche avec la barre de recherche mais aussi choisir un intervalle de dates.
   * Le tri peut se faire par rapport aux éléments du tableau et de checkboxes des agences et de si les EP ont été terminé et non signé.
   * Les assistantes peuvent accéder directement aux informations du collaborateur concerné, du référent actuel et de l'EP, si ce dernier a été saisie.
-  * LEs informations qui seront affichées sont : l'agence, le collaborateur, son ancienneté, le référent, la date d'envoie du mail, l'état, le type d'EP et la date prévu d'entretien
+  * LEs informations qui seront affichées sont : l'agence, le collaborateur, son ancienneté, le référent, la date d'envoie du mail, l'état, le type d'EP et la date prévu d'entretien.
   */
 @Component({
   selector : 'home-assistante',
@@ -117,7 +117,7 @@ export class HomeAssistanteComponent implements OnInit, AfterViewInit {
   }
 
   /**
-    * Récupérer la liste des EP Disponibles dès l'initialisation
+    * Récupérer la liste des EP Disponibles dès l'initialisation.
     */
   ngOnInit() {
     console.log("INIT");
@@ -130,7 +130,7 @@ export class HomeAssistanteComponent implements OnInit, AfterViewInit {
 
 
   /**
-    * Cette fonction permet de mettre à jour le filtre du tableau
+    * Cette fonction permet de mettre à jour les informations du tableau en fontionne de la barre de recherche
     */
   applyFilter(filterValue: string) {
     console.log(filterValue);

src/app/home/home-rh/home-rh.component.ts

@@ -1,10 +1,10 @@
 import { Component, OnInit } from '@angular/core';
 
 /**
-  * Le composant home qui sera affiché pour les RH
+  * Le composant home qui sera affiché pour les RH.
-  * Cette interface affiche la liste des prochaines formations
+  * Cette interface affiche la liste des prochaines formations.
-  * Les informations qui seront affichées sont : le libellé, la date prévu, le nombre de participant, l'état de la formation
+  * Les informations qui seront affichées sont : le libellé, la date prévu, le nombre de participant, l'état de la formation.
-  * Il est possible d'accéder aux informations de la formation depuis le home
+  * Il est possible d'accéder aux informations de la formation depuis le home.
   */
 @Component({
   selector : 'home-rh',

src/app/modeles/modele-formation.ts

@@ -1,7 +1,7 @@
 import { CollaborateurModel } from "./modele-collaborateur";
 
 /**
-  * Modèle des formations
+  * Modèle des formations.
   */
 export class FormationModel {
   idFormation? : number;
@@ -49,7 +49,7 @@ export interface ParticipationFormationModel {
 
 
 /**
-  * Le modèle des évaluations, il contient les réponses à  un critère
+  * Le modèle des évaluations, il contient les réponses à  un critère.
   */
 export class EvaluationFormationModel {
   note? : number;
@@ -58,7 +58,7 @@ export class EvaluationFormationModel {
 }
 
 /**
-  * Les critères sont les questions qui sont posées au collaborateur
+  * Les critères sont les questions qui sont posées au collaborateur.
   */
 export interface CritereModel {
   idCritere?: number;

src/app/nav-menu/nav-menu-assistante/nav-menu-assistante.component.ts

@@ -1,8 +1,8 @@
 import { Component } from "@angular/core";
 
 /**
-  * Le nav-menu qui sera affiché pour l'assistante
+  * Le nav-menu qui sera affiché pour l'assistante.
-  * La navigation des assistantes : accès à la liste des référents, accès à la liste des collaborateurs, accès à la liste de tous les EP
+  * La navigation des assistantes : accès à la liste des référents, accès à la liste des collaborateurs, accès à la liste de tous les EP.
   */
 @Component({
   selector : "app-nav-menu-assistante",

src/app/nav-menu/nav-menu-collaborateur/nav-menu-collaborateur.component.ts

@@ -1,8 +1,9 @@
 import { Component } from "@angular/core";
 
 /**
-  * Le nav-menu qui sera affiché pour les collaborateurs
+  * Le nav-menu qui sera affiché pour les collaborateurs.
-  * La navigation des collaborateurs :
+  * La navigation des collaborateurs : accès à leur liste d'EP, accès à leur liste de formation.
+  * Cas des référents : accès aux demandesd de délégation.
   */
 @Component({
   selector : "app-nav-menu-collaborateur",

src/app/nav-menu/nav-menu-commercial/nav-menu-commercial.component.ts

@@ -1,8 +1,8 @@
 import { Component } from "@angular/core";
 
 /**
-  * Le nav-menu qui sera affiché pour les collaborateurs
+  * Le nav-menu qui sera affiché pour les commerciaux.
-  * La navigation des collaborateurs :
+  * La navigation des commerciaux : accès liste des collaborateurs, accès liste EP, accès liste des formations.
   */
 @Component({
   selector : "app-nav-menu-commercial",

src/app/nav-menu/nav-menu-rh/nav-menu-rh.component.ts

@@ -1,8 +1,8 @@
 import { Component } from "@angular/core";
 
 /**
-  * Le nav-menu qui sera affiché pour les collaborateurs
+  * Le nav-menu qui sera affiché pour les RH.
-  * La navigation des collaborateurs :
+  * La navigation des RH : accès liste collaborateurs, accès liste demandes de formation, accès liste formations, accès création formation, accès création demande de formation.
   */
 @Component({
   selector : "app-nav-menu-rh",

src/app/nav-menu/nav-menu.component.ts

@@ -9,8 +9,8 @@ import { environment } from '../../environments/'
   * Le composant du nav menu de base.
   * Ce composant se charge de faire afficher le bon nav pour chaque utilisateur en fonction du rôle de ce dernier.
   * Liste des nav utilisateurs : nav-menu-assistante, nav-menu-collaborateur, nav-menu-commercial et nav-menu-rh.
-  * Chaque nav permettra à chaque utilisateur d'avoir sa navigation
+  * Chaque nav permettra à chaque utilisateur d'avoir sa navigation.
-  * Le nav menu pour tous affichera affiche les informs de l'utilisateur (nom+prénom) et permettra de se déconnecter
+  * Le nav menu pour tous affichera affiche les informs de l'utilisateur (nom+prénom) et permettra de se déconnecter.
   */
 @Component({
   selector: 'app-nav-menu',

src/app/utils/displayEP.ts

@@ -1,5 +1,5 @@
 /**
-  * Class pour récupérer les informations d'un EP qui seront affichées et/ou utilisées
+  * Class pour récupérer les informations d'un EP qui seront affichées et/ou utilisées.
   */
 
 export class DisplayEP {

src/app/utils/roles.ts

@@ -1,5 +1,5 @@
 /**
-  * Enumération des rôles utilisateur dans Keycloak
+  * Enumération des rôles utilisateur dans Keycloak.
   */
 export enum Role {
   collaborateur = "Collaborateur",