Elaborate doc

5 files changed, 60 insertions, 59 deletions

diff --git a/src/ch/epfl/xblast/client/Client.java b/src/ch/epfl/xblast/client/Client.java
index 8ccea00..24ca727 100644
--- a/src/ch/epfl/xblast/client/Client.java
+++ b/src/ch/epfl/xblast/client/Client.java
@@ -40,7 +40,7 @@ public class Client {
     private static class Channel {
 
         /**
-         * Transform a buffer to a list of bytes.
+         * Transforms a buffer to a list of bytes.
          *
          * @param buf given buffer
          * @return the list of bytes built from the given buffer
@@ -55,7 +55,7 @@ public class Client {
         }
 
         /**
-         * Create the UDP communication Channel.
+         * Creates the UDP communication Channel.
          *
          * @return the UDP communication Channel
          */
@@ -98,7 +98,7 @@ public class Client {
         }
 
         /**
-         * Close the Channel.
+         * Closes the Channel.
          */
         void closeChannel() {
             try {
@@ -109,7 +109,7 @@ public class Client {
         }
 
         /**
-         * Send an action through the Channel.
+         * Sends an action through the Channel.
          *
          * @param action action to send
          */
@@ -118,9 +118,9 @@ public class Client {
         }
 
         /**
-         * Receive a GameState through the Channel.
+         * Receives a GameState through the Channel.
          *
-         * @param block
+         * @param block wait for an incoming game state before returning
          * @return the received GameState
          */
         List<Byte> receiveGameState(boolean block) {
@@ -134,7 +134,7 @@ public class Client {
         }
 
         /**
-         * Send a byte through the Channel.
+         * Sends a byte through the Channel.
          *
          * @param b byte to send
          */
@@ -143,7 +143,7 @@ public class Client {
         }
 
         /**
-         * Send the content of a buffer.
+         * Sends the content of a buffer.
          *
          * @param b buffer containing the bytes to send
          */
@@ -156,9 +156,9 @@ public class Client {
         }
 
         /**
-         * Receive data from the Channel.
+         * Receives data from the Channel.
          *
-         * @param block
+         * @param block wait for an incoming byte before returning
          * @return the received data
          */
         private Optional<List<Byte>> receive(boolean block) {
@@ -182,7 +182,7 @@ public class Client {
     private static class GUI {
 
         /**
-         * Build the window.
+         * Builds the window.
          *
          * @param content content of the window
          * @return the frame
@@ -199,7 +199,8 @@ public class Client {
         }
 
         /**
-         * Attach the keyboard events handler to the component.
+         * Attaches the keyboard event handler to the component.
+         *
          * @param comp component
          * @param actionConsumer actionConsumer corresponding to the keyboardEventHandler
          */
@@ -225,7 +226,7 @@ public class Client {
         }
 
         /**
-         * Build and display the GUI.
+         * Builds and display the GUI.
          */
         public void display() {
             buildFrame(this.gameComponent);
@@ -233,7 +234,7 @@ public class Client {
         }
 
         /**
-         * Update the displayed GameState.
+         * Updates the displayed GameState.
          *
          * @param gs new GameState to be displayed
          * @param p Player ID corresponding to the client
@@ -245,7 +246,7 @@ public class Client {
     }
 
     /**
-     * Deserialize the players' IDs.
+     * Deserializes the players' IDs.
      *
      * @param b a given byte
      * @return the Player ID corresponding to the given byte
@@ -262,7 +263,7 @@ public class Client {
     }
 
     /**
-     * Deserialize a received GameState.
+     * Deserializes a received GameState.
      *
      * @param b the serialized GameState
      * @return the deserialized GameState
@@ -282,7 +283,7 @@ public class Client {
     private final GUI gui;
 
     /**
-     * Instatiates a new client.
+     * Instantiates a new client.
      *
      * @param host hostname
      * @param port port
@@ -293,7 +294,7 @@ public class Client {
     }
 
     /**
-     * Run the whole client.
+     * Runs the whole client.
      */
     public void run() {
         this.displayGUI();
@@ -303,7 +304,7 @@ public class Client {
     }
 
     /**
-     * Display the Graphical User Interface.
+     * Displays the Graphical User Interface.
      */
     private void displayGUI() {
         try {
@@ -315,7 +316,7 @@ public class Client {
     }
 
     /**
-     * Launch the game.
+     * Launches the game.
      */
     private void runGame() {
         while (true)
@@ -323,7 +324,7 @@ public class Client {
     }
 
     /**
-     * Connect to the server and fetch the new GameState.
+     * Connects to the server and fetch the new GameState.
      */
     private void establishConnection() {
         Thread joinThread = new Thread(this::sendJoinRequest);
@@ -333,7 +334,7 @@ public class Client {
     }
 
     /**
-     * Fetch the new GameState.
+     * Fetches the new GameState.
      */
     private void updateGameState() {
         List<Byte> serializedGameState = this.channel.receiveGameState(true);
@@ -347,7 +348,7 @@ public class Client {
     }