Improve the documentation for the client package

3 files changed, 232 insertions, 0 deletions

diff --git a/src/ch/epfl/xblast/client/Client.java b/src/ch/epfl/xblast/client/Client.java
index b522312..8ccea00 100644
--- a/src/ch/epfl/xblast/client/Client.java
+++ b/src/ch/epfl/xblast/client/Client.java
@@ -26,13 +26,25 @@ import java.util.function.Consumer;
  */
 public class Client {
 
+    /**
+     * Client's parameters.
+     */
     private static final String DEFAULT_SERVER_HOST = "localhost";
     private static final int DEFAULT_SERVER_PORT = Server.DEFAULT_PORT;
     private static final int PACKET_MAX_SIZE = 1000;
     private static final long REGISTER_PING_INTERVAL = 1 * Time.NS_PER_S; // ns
 
+    /**
+     * Communication channel.
+     */
     private static class Channel {
 
+        /**
+         * Transform a buffer to a list of bytes.
+         *
+         * @param buf given buffer
+         * @return the list of bytes built from the given buffer
+         */
         private static List<Byte> bufferToList(ByteBuffer buf) {
             List<Byte> l = new ArrayList<>(buf.remaining());
 
@@ -42,6 +54,11 @@ public class Client {
             return Collections.unmodifiableList(l);
         }
 
+        /**
+         * Create the UDP communication Channel.
+         *
+         * @return the UDP communication Channel
+         */
         private static DatagramChannel openChannel() {
             try {
                 return DatagramChannel.open(StandardProtocolFamily.INET);
@@ -52,20 +69,37 @@ public class Client {
             }
         }
 
+        /**
+         * Parameters of the Channel.
+         */
         private final SocketAddress serverAddr;
         private final DatagramChannel channel;
 
+        /**
+         * Instantiates a new Channel.
+         *
+         * @param iface socket
+         */
         Channel(InetSocketAddress iface) {
             this.serverAddr = iface;
             this.channel = openChannel();
         }
 
+        /**
+         * Instantiates a new Channel.
+         *
+         * @param host hostname
+         * @param port port
+         */
         Channel(String host, Integer port) {
             this(new InetSocketAddress(
                     Optional.ofNullable(host).orElse(DEFAULT_SERVER_HOST),
                     Optional.ofNullable(port).orElse(DEFAULT_SERVER_PORT)));
         }
 
+        /**
+         * Close the Channel.
+         */
         void closeChannel() {
             try {
                 this.channel.close();
@@ -74,10 +108,21 @@ public class Client {
             }
         }
 
+        /**
+         * Send an action through the Channel.
+         *
+         * @param action action to send
+         */
         void sendAction(PlayerAction action) {
             this.sendByte(action.toByte());
         }
 
+        /**
+         * Receive a GameState through the Channel.
+         *
+         * @param block
+         * @return the received GameState
+         */
         List<Byte> receiveGameState(boolean block) {
             Optional<List<Byte>> state;
 
@@ -88,10 +133,20 @@ public class Client {
             return state.get();
         }
 
+        /**
+         * Send a byte through the Channel.
+         *
+         * @param b byte to send
+         */
         private void sendByte(byte b) {
             this.send(ByteBuffer.wrap(new byte[]{b}));
         }
 
+        /**
+         * Send the content of a buffer.
+         *
+         * @param b buffer containing the bytes to send
+         */
         private void send(ByteBuffer b) {
             try {
                 this.channel.send(b, this.serverAddr);
@@ -100,6 +155,12 @@ public class Client {
             }
         }
 
+        /**
+         * Receive data from the Channel.
+         *
+         * @param block
+         * @return the received data
+         */
         private Optional<List<Byte>> receive(boolean block) {
             try {
                 ByteBuffer buf = ByteBuffer.allocate(PACKET_MAX_SIZE);
@@ -115,8 +176,17 @@ public class Client {
 
     }
 
+    /**
+     * The Graphical User Interface.
+     */
     private static class GUI {
 
+        /**
+         * Build the window.
+         *
+         * @param content content of the window
+         * @return the frame
+         */
         private static JFrame buildFrame(Container content) {
             JFrame frame = new JFrame();
             frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
@@ -128,30 +198,58 @@ public class Client {
             return frame;
         }
 
+        /**
+         * Attach the keyboard events handler to the component.
+         * @param comp component
+         * @param actionConsumer actionConsumer corresponding to the keyboardEventHandler
+         */
         private static void attachKeyboardHandler(Component comp, Consumer<PlayerAction> actionConsumer) {
             comp.addKeyListener(new KeyboardEventHandler(actionConsumer));
             comp.requestFocusInWindow();
         }
 
+        /**
+         * GUI's parameters.
+         */
         private final XBlastComponent gameComponent;
         private final Consumer<PlayerAction> actionConsumer;
 
+        /**
+         * Instantiates a new GUI.
+         *
+         * @param actionConsumer actionConsumer corresponding to the keyboardEventHandler
+         */
         GUI(Consumer<PlayerAction> actionConsumer) {
             this.gameComponent = new XBlastComponent();
             this.actionConsumer = actionConsumer;
         }
 
+        /**
+         * Build and display the GUI.
+         */
         public void display() {
             buildFrame(this.gameComponent);
             attachKeyboardHandler(this.gameComponent, this.actionConsumer);
         }