Added documentation for client and common classes

Author: gabrieldiem

client_src/game_protocol_client.cpp

@@ -70,6 +70,7 @@ const uint8_t GameProtocolClient::receive_enemy_event() {
 const std::string GameProtocolClient::get_enemy_event_message(
         const uint8_t& enemy_event_code, const std::string& ENEMY_DIED_EVENT_MESSAGE,
         const std::string& ENEMY_REVIVED_EVENT_MESSAGE) const {
+
     if (enemy_event_code == this->game_commands.get_enemy_died_code()) {
         return ENEMY_DIED_EVENT_MESSAGE;
 

client_src/game_protocol_client.h

@@ -20,13 +20,6 @@ class GameProtocolClient {
     bool is_skt_closed;
     GameCommands game_commands;
 
-    /*
-     *  Receives all the information from the server to build a valid GameMessage
-     */
-    const GameMessage receive_message_from_server(const std::string& ENEMY_DIED_EVENT_MESSAGE,
-                                                  const std::string& ENEMY_REVIVED_EVENT_MESSAGE);
-
-
     /*
      *  Receives from the server code that represents the start of a broadcast message
      */
@@ -47,10 +40,19 @@ class GameProtocolClient {
      */
     const uint8_t receive_enemy_event();
 
+    /*
+     *  Translates the command codes into a string message with the function arguments
+     */
     const std::string get_enemy_event_message(const uint8_t& enemy_event_code,
                                               const std::string& ENEMY_DIED_EVENT_MESSAGE,
                                               const std::string& ENEMY_REVIVED_EVENT_MESSAGE) const;
 
+    /*
+     *  Receives all the information from the server to build a valid GameMessage
+     */
+    const GameMessage receive_message_from_server(const std::string& ENEMY_DIED_EVENT_MESSAGE,
+                                                  const std::string& ENEMY_REVIVED_EVENT_MESSAGE);
+
 public:
     /*
      *  GameProtocolClient handles the way the client should interact with the server, in terms of
@@ -73,6 +75,9 @@ class GameProtocolClient {
     GameProtocolClient(GameProtocolClient&&) = default;
     GameProtocolClient& operator=(GameProtocolClient&&) = default;
 
+    /*
+     *   Sends an attack message to the server
+     */
     void send_attack();
 
 

client_src/jazz_jackrabbit_2_game_client.h

@@ -14,8 +14,7 @@ class JazzJackrabbit2GameClient {
     const std::vector<std::string> available_user_options;
 
     /*
-     *  Compares two options in equal conditions (both are sanitized with
-     * JazzJackrabbit2GameClient::sanitize_string) and returns true if they are equal
+     *  Compares two options in equal conditions and returns true if they are equal
      */
     const bool are_options_equal(const std::string& option1, const std::string& option2) const;
 
@@ -36,25 +35,16 @@ class JazzJackrabbit2GameClient {
     void vectorize_user_input(const std::string& user_input,
                               std::vector<std::string>& user_input_vectorized);
 
-    /*
-     *  Calls the appropiate method depending on the desired action
-     */
-    void execute_command(const std::vector<std::string>& user_input_vectorized);
 
     /*
-     *  Returns an uppercase copy of the string
-     */
-    const std::string string_to_uppercase(const std::string& string) const;
-
-    /*
-     *  Returns the result of JazzJackrabbit2GameClient::string_to_uppercase
+     *  Uses the client_protocol to send an attack to the server
      */
-    const std::string sanitize_string(const std::string& string) const;
+    void execute_attack(const std::vector<std::string>& user_input_vectorized);
 
     /*
-     *  Uses the client_protocol to send an attack to the server
+     *  Prints to std::out the message read from the server
      */
-    void execute_attack(const std::vector<std::string>& user_input_vectorized);
+    void print_messages_from_server(const std::vector<GameMessage>& messages) const;
 
     /*
      *  Uses the client_protocol to block the I/O until read all the messages expressed
@@ -63,9 +53,9 @@ class JazzJackrabbit2GameClient {
     void execute_read_from_server(const std::vector<std::string>& user_input_vectorized);
 
     /*
-     *  Prints to std::out the message read from the server
+     *  Calls the appropiate method depending on the desired action
      */
-    void print_messages_from_server(const std::vector<GameMessage>& messages) const;
+    void execute_command(const std::vector<std::string>& user_input_vectorized);
 
 public:
     /*

common_src/game_commands.cpp

@@ -35,12 +35,10 @@ const uint8_t GameCommands::get_enemy_revived_code() const {
 
 
 const std::string GameCommands::get_key_from_code(const uint8_t& cmd_code) const {
-    // A lambda expression detects if this is the correct command by code
-    // It will be evaluated in each iteration of the search loop
     auto lambda_is_searched_cmd = [&cmd_code](const auto& command) {
         return command.second == cmd_code;
     };
-    // Iterate through the map until it founds the matching command
+
     auto found_command = std::find_if(this->game_commands_map.begin(),
                                       this->game_commands_map.end(), lambda_is_searched_cmd);
 

server_src/game_server_engine.cpp

@@ -138,6 +138,7 @@ void GameServerEngine::broadcast_revived_enemies_if_any(const uint16_t& revived_
     }
 }
 
+
 void GameServerEngine::run() {
     while (!this->should_server_shutdown()) {
         std::string next_cmd;