From aa21e6a56c5cbc8a797699294d761c641e461d3b Mon Sep 17 00:00:00 2001
From: alartigu <alartigu@etud.insa-toulouse.fr>
Date: Mon, 30 Nov 2020 15:32:55 +0100
Subject: [PATCH] Ajout de la javadoc

---
 Implementation/src/ChatApp.java    | 18 +++++++++++++
 Implementation/src/UDPEchange.java | 41 ++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)

diff --git a/Implementation/src/ChatApp.java b/Implementation/src/ChatApp.java
index 4a71dd6..a597b76 100644
--- a/Implementation/src/ChatApp.java
+++ b/Implementation/src/ChatApp.java
@@ -5,6 +5,12 @@ import java.util.ArrayList;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
+/**
+* <p>
+* Classe récapitulant toutes les actions possibles pour un utilisateur
+* </p>
+*/
+
 public class ChatApp {
 	
 	/* Liste des utilisateurs actifs */
@@ -13,6 +19,12 @@ public class ChatApp {
 	/* ChatApp est associé à un utilisateur */
 	private Utilisateur me;
 	
+	 /**
+     * Constructeur de l'application de chat
+     * 
+     * @param pseudo Pseudo de l'utilisateur
+     * @param port Port de communication 
+     */
 	public ChatApp(String pseudo, Integer port){
 		this.actifUsers = new ArrayList<Utilisateur>() ;
 	    // Recuperer adresse IP de l'utilisateur 
@@ -26,6 +38,11 @@ public class ChatApp {
 		this.me = new Utilisateur(pseudo,port,ip);
 		this.actifUsers.add(me);
 	}
+	/**
+     * Ajouter des utilisateurs actifs dans l'attribut liste 'actifUsers'
+     * 
+     * @param u on va rajouter cet utilisateur dans la liste
+     */
 	public void addList(Utilisateur u) {
 		this.actifUsers.add(u);
 	}
@@ -37,6 +54,7 @@ public class ChatApp {
         }	      
 	}
 	
+	
 	public void connexion() throws IOException {
 		// @ de broadcast du réseau de l'utilisateur me 
 	    InetAddress broadcastAdress = InetAddress.getLoopbackAddress(); // A MODIFIER 
diff --git a/Implementation/src/UDPEchange.java b/Implementation/src/UDPEchange.java
index 5dfdc77..f176f9d 100644
--- a/Implementation/src/UDPEchange.java
+++ b/Implementation/src/UDPEchange.java
@@ -5,9 +5,25 @@ import java.net.InetAddress;
 import java.net.SocketException;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
+/**
+* <p>
+* Classe representant les échanges UDP entre utilisateurs.
+* </p>
+*/
 
 public class UDPEchange {
 	
+	/**
+     * <p>
+     * Méthode permettant d'envoyer un message à tout les utilisateurs
+     * à l'aide du protocole UDP
+     * </p>
+     * 
+     * @param broadcastAdress l'addresse de broadcast du réseau
+     * @param broadcastMessage correspond au message à transmettre aux utilisateurs
+     * @param port : port destination 
+     * 
+     */
 	public static void connexion( InetAddress broadcastAdress , String broadcastMessage , Integer port) throws IOException {
 		// Envoie en broadcast à tous les utilsateurs
 		DatagramSocket socket = new DatagramSocket();
@@ -19,6 +35,15 @@ public class UDPEchange {
 	    System.out.println(broadcastMessage);
 	}
 	
+	/**
+     * <p>
+     * Méthode permettant la reception de messages d'utilisateurs
+     * à l'aide du protocole UDP
+     * </p>
+     * 
+     * @param app L'application de chat de l'utilisateur qui receptionne le message
+     * 
+     */
 	public static void ecouteUDP(ChatApp app)
 	{
 		DatagramSocket socket = null;
@@ -37,10 +62,18 @@ public class UDPEchange {
 			} catch (IOException e) {
 				e.printStackTrace();
 			} 
+	        // Un thread est lancé à chaque reception d'un message
 	        exec.submit(new RunnerUDP(data,app));
 	       }
 	}
 }
+
+/**
+* <p>
+* Classe implémentant l'interface Runnable. 
+* Contient les traitements à executer dans un thread lancer par des méthodes de la class UDPEchange
+* </p>
+*/
 class RunnerUDP implements Runnable {
     final DatagramPacket data ;
     ChatApp app ; 
@@ -49,6 +82,14 @@ class RunnerUDP implements Runnable {
         this.data= data;
         this.app = app ;
     }
+    
+    /**
+     * <p>
+     * Méthode qui redefinie les traitements qui seront exécutés dans le thread:
+     * Met à jour la liste des utilisateurs actifs
+     * </p>
+     * 
+     */
     @Override
     public void run() {
         System.out.println("Thread started");