input_mapping: Amend specification of parameters

param tags are supposed to specify the parameter name without any
quoting.

Silences several -Wdocumentation warnings.

src/input_common/drivers/tas_input.cpp

@@ -3,7 +3,6 @@
 // Refer to the license.txt file included.
 
 #include <cstring>
-#include <regex>
 #include <fmt/format.h>
 
 #include "common/fs/file.h"
@@ -15,7 +14,7 @@
 
 namespace InputCommon::TasInput {
 
-enum TasAxes : u8 {
+enum class Tas::TasAxis : u8 {
     StickX,
     StickY,
     SubstickX,
@@ -66,7 +65,7 @@ Tas::Tas(std::string input_engine_) : InputEngine(std::move(input_engine_)) {
 
 Tas::~Tas() {
     Stop();
-};
+}
 
 void Tas::LoadTasFiles() {
     script_length = 0;
@@ -79,43 +78,43 @@ void Tas::LoadTasFiles() {
 }
 
 void Tas::LoadTasFile(size_t player_index, size_t file_index) {
-    if (!commands[player_index].empty()) {
-        commands[player_index].clear();
-    }
+    commands[player_index].clear();
+
     std::string file = Common::FS::ReadStringFromFile(
         Common::FS::GetYuzuPath(Common::FS::YuzuPath::TASDir) /
             fmt::format("script{}-{}.txt", file_index, player_index + 1),
         Common::FS::FileType::BinaryFile);
-    std::stringstream command_line(file);
+    std::istringstream command_line(file);
     std::string line;
     int frame_no = 0;
     while (std::getline(command_line, line, '\n')) {
         if (line.empty()) {
             continue;
         }
-        std::smatch m;
 
-        std::stringstream linestream(line);
-        std::string segment;
-        std::vector<std::string> seglist;
-
-        while (std::getline(linestream, segment, ' ')) {
-            seglist.push_back(segment);
+        std::vector<std::string> seg_list;
+        {
+            std::istringstream line_stream(line);
+            std::string segment;
+            while (std::getline(line_stream, segment, ' ')) {
+                seg_list.push_back(std::move(segment));
+            }
         }
 
-        if (seglist.size() < 4) {
+        if (seg_list.size() < 4) {
             continue;
         }
 
-        while (frame_no < std::stoi(seglist.at(0))) {
-            commands[player_index].push_back({});
+        const auto num_frames = std::stoi(seg_list[0]);
+        while (frame_no < num_frames) {
+            commands[player_index].emplace_back();
             frame_no++;
         }
 
         TASCommand command = {
-            .buttons = ReadCommandButtons(seglist.at(1)),
-            .l_axis = ReadCommandAxis(seglist.at(2)),
-            .r_axis = ReadCommandAxis(seglist.at(3)),
+            .buttons = ReadCommandButtons(seg_list[1]),
+            .l_axis = ReadCommandAxis(seg_list[2]),
+            .r_axis = ReadCommandAxis(seg_list[3]),
         };
         commands[player_index].push_back(command);
         frame_no++;
@@ -123,16 +122,17 @@ void Tas::LoadTasFile(size_t player_index, size_t file_index) {
     LOG_INFO(Input, "TAS file loaded! {} frames", frame_no);
 }
 
-void Tas::WriteTasFile(std::u8string file_name) {
+void Tas::WriteTasFile(std::u8string_view file_name) {
     std::string output_text;
     for (size_t frame = 0; frame < record_commands.size(); frame++) {
         const TASCommand& line = record_commands[frame];
         output_text += fmt::format("{} {} {} {}\n", frame, WriteCommandButtons(line.buttons),
                                    WriteCommandAxis(line.l_axis), WriteCommandAxis(line.r_axis));
     }
-    const auto bytes_written = Common::FS::WriteStringToFile(
-        Common::FS::GetYuzuPath(Common::FS::YuzuPath::TASDir) / file_name,
-        Common::FS::FileType::TextFile, output_text);
+
+    const auto tas_file_name = Common::FS::GetYuzuPath(Common::FS::YuzuPath::TASDir) / file_name;
+    const auto bytes_written =
+        Common::FS::WriteStringToFile(tas_file_name, Common::FS::FileType::TextFile, output_text);
     if (bytes_written == output_text.size()) {
         LOG_INFO(Input, "TAS file written to file!");
     } else {
@@ -205,10 +205,10 @@ void Tas::UpdateThread() {
                 const int button = static_cast<int>(i);
                 SetButton(identifier, button, button_status);
             }
-            SetAxis(identifier, TasAxes::StickX, command.l_axis.x);
-            SetAxis(identifier, TasAxes::StickY, command.l_axis.y);
-            SetAxis(identifier, TasAxes::SubstickX, command.r_axis.x);
-            SetAxis(identifier, TasAxes::SubstickY, command.r_axis.y);
+            SetTasAxis(identifier, TasAxis::StickX, command.l_axis.x);
+            SetTasAxis(identifier, TasAxis::StickY, command.l_axis.y);
+            SetTasAxis(identifier, TasAxis::SubstickX, command.r_axis.x);
+            SetTasAxis(identifier, TasAxis::SubstickY, command.r_axis.y);
         }
     } else {
         is_running = Settings::values.tas_loop.GetValue();
@@ -224,27 +224,28 @@ void Tas::ClearInput() {
 }
 
 TasAnalog Tas::ReadCommandAxis(const std::string& line) const {
-    std::stringstream linestream(line);
-    std::string segment;
-    std::vector<std::string> seglist;
-
-    while (std::getline(linestream, segment, ';')) {
-        seglist.push_back(segment);
+    std::vector<std::string> seg_list;
+    {
+        std::istringstream line_stream(line);
+        std::string segment;
+        while (std::getline(line_stream, segment, ';')) {
+            seg_list.push_back(std::move(segment));
+        }
     }
 
-    const float x = std::stof(seglist.at(0)) / 32767.0f;
-    const float y = std::stof(seglist.at(1)) / 32767.0f;
+    const float x = std::stof(seg_list.at(0)) / 32767.0f;
+    const float y = std::stof(seg_list.at(1)) / 32767.0f;
 
     return {x, y};
 }
 
-u64 Tas::ReadCommandButtons(const std::string& data) const {
-    std::stringstream button_text(data);
-    std::string line;
+u64 Tas::ReadCommandButtons(const std::string& line) const {
+    std::istringstream button_text(line);
+    std::string button_line;
     u64 buttons = 0;
-    while (std::getline(button_text, line, ';')) {
-        for (auto [text, tas_button] : text_to_tas_button) {
-            if (text == line) {
+    while (std::getline(button_text, button_line, ';')) {
+        for (const auto& [text, tas_button] : text_to_tas_button) {
+            if (text == button_line) {
                 buttons |= static_cast<u64>(tas_button);
                 break;
             }
@@ -254,8 +255,8 @@ u64 Tas::ReadCommandButtons(const std::string& data) const {
 }
 
 std::string Tas::WriteCommandButtons(u64 buttons) const {
-    std::string returns = "";
-    for (auto [text_button, tas_button] : text_to_tas_button) {
+    std::string returns;
+    for (const auto& [text_button, tas_button] : text_to_tas_button) {
         if ((buttons & static_cast<u64>(tas_button)) != 0) {
             returns += fmt::format("{};", text_button);
         }
@@ -267,6 +268,10 @@ std::string Tas::WriteCommandAxis(TasAnalog analog) const {
     return fmt::format("{};{}", analog.x * 32767, analog.y * 32767);
 }
 
+void Tas::SetTasAxis(const PadIdentifier& identifier, TasAxis axis, f32 value) {
+    SetAxis(identifier, static_cast<int>(axis), value);
+}
+
 void Tas::StartStop() {
     if (!Settings::values.tas_enable) {
         return;

src/input_common/drivers/tas_input.h

@@ -5,11 +5,11 @@
 #pragma once
 
 #include <array>
+#include <string>
+#include <vector>
 
 #include "common/common_types.h"
-#include "common/settings_input.h"
 #include "input_common/input_engine.h"
-#include "input_common/main.h"
 
 /*
 To play back TAS scripts on Yuzu, select the folder with scripts in the configuration menu below
@@ -88,39 +88,39 @@ public:
 
     /**
      * Changes the input status that will be stored in each frame
-     * @param buttons: bitfield with the status of the buttons
-     * @param left_axis: value of the left axis
-     * @param right_axis: value of the right axis
+     * @param buttons    Bitfield with the status of the buttons
+     * @param left_axis  Value of the left axis
+     * @param right_axis Value of the right axis
      */
     void RecordInput(u64 buttons, TasAnalog left_axis, TasAnalog right_axis);
 
     // Main loop that records or executes input
     void UpdateThread();
 
-    //  Sets the flag to start or stop the TAS command excecution and swaps controllers profiles
+    // Sets the flag to start or stop the TAS command execution and swaps controllers profiles
     void StartStop();
 
-    //  Stop the TAS and reverts any controller profile
+    // Stop the TAS and reverts any controller profile
     void Stop();
 
-    // Sets the flag to reload the file and start from the begining in the next update
+    // Sets the flag to reload the file and start from the beginning in the next update
     void Reset();
 
     /**
      * Sets the flag to enable or disable recording of inputs
-     * @return Returns true if the current recording status is enabled
+     * @returns true if the current recording status is enabled
      */
     bool Record();
 
     /**
      * Saves contents of record_commands on a file
-     * @param overwrite_file: Indicates if player 1 should be overwritten
+     * @param overwrite_file Indicates if player 1 should be overwritten
      */
     void SaveRecording(bool overwrite_file);
 
     /**
      * Returns the current status values of TAS playback/recording
-     * @return Tuple of
+     * @returns A Tuple of
      * TasState indicating the current state out of Running ;
      * Current playback progress ;
      * Total length of script file currently loaded or being recorded
@@ -128,6 +128,8 @@ public:
     std::tuple<TasState, size_t, size_t> GetStatus() const;
 
 private:
+    enum class TasAxis : u8;
+
     struct TASCommand {
         u64 buttons{};
         TasAnalog l_axis{};
@@ -137,29 +139,31 @@ private:
     /// Loads TAS files from all players
     void LoadTasFiles();
 
-    /** Loads TAS file from the specified player
-     * @param player_index: player number to save the script
-     * @param file_index: script number of the file
+    /**
+     * Loads TAS file from the specified player
+     * @param player_index Player number to save the script
+     * @param file_index   Script number of the file
      */
     void LoadTasFile(size_t player_index, size_t file_index);
 
-    /** Writes a TAS file from the recorded commands
-     * @param file_name: name of the file to be written
+    /**
+     * Writes a TAS file from the recorded commands
+     * @param file_name Name of the file to be written
      */
-    void WriteTasFile(std::u8string file_name);
+    void WriteTasFile(std::u8string_view file_name);
 
     /**
      * Parses a string containing the axis values. X and Y have a range from -32767 to 32767
-     * @param line: string containing axis values with the following format "x;y"
-     * @return Returns a TAS analog object with axis values with range from -1.0 to 1.0
+     * @param line String containing axis values with the following format "x;y"
+     * @returns A TAS analog object with axis values with range from -1.0 to 1.0
      */
     TasAnalog ReadCommandAxis(const std::string& line) const;
 
     /**
      * Parses a string containing the button values. Each button is represented by it's text format
      * specified in text_to_tas_button array
-     * @param line: string containing button name with the following format "a;b;c;d..."
-     * @return Returns a u64 with each bit representing the status of a button
+     * @param line string containing button name with the following format "a;b;c;d..."
+     * @returns A u64 with each bit representing the status of a button
      */
     u64 ReadCommandButtons(const std::string& line) const;
 
@@ -170,17 +174,20 @@ private:
 
     /**
      * Converts an u64 containing the button status into the text equivalent
-     * @param buttons: bitfield with the status of the buttons
-     * @return Returns a string with the name of the buttons to be written to the file
+     * @param buttons Bitfield with the status of the buttons
+     * @returns A string with the name of the buttons to be written to the file
      */
     std::string WriteCommandButtons(u64 buttons) const;
 
     /**
      * Converts an TAS analog object containing the axis status into the text equivalent
-     * @param data: value of the axis
-     * @return A string with the value of the axis to be written to the file
+     * @param analog Value of the axis
+     * @returns A string with the value of the axis to be written to the file
      */
-    std::string WriteCommandAxis(TasAnalog data) const;
+    std::string WriteCommandAxis(TasAnalog analog) const;
+
+    /// Sets an axis for a particular pad to the given value.
+    void SetTasAxis(const PadIdentifier& identifier, TasAxis axis, f32 value);
 
     size_t script_length{0};
     bool is_recording{false};

src/input_common/input_mapping.h

@@ -14,8 +14,8 @@ public:
     MappingFactory();
 
     /**
-     * Resets all varables to beggin the mapping process
-     * @param "type": type of input desired to be returned
+     * Resets all variables to begin the mapping process
+     * @param type type of input desired to be returned
      */
     void BeginMapping(Polling::InputType type);
 
@@ -24,8 +24,8 @@ public:
 
     /**
      * Registers mapping input data from the driver
-     * @param "data": An struct containing all the information needed to create a proper
-     * ParamPackage
+     * @param data A struct containing all the information needed to create a proper
+     *             ParamPackage
      */
     void RegisterInput(const MappingData& data);
 
@@ -34,42 +34,42 @@ public:
 
 private:
     /**
-     * If provided data satisfies the requeriments it will push an element to the input_queue
+     * If provided data satisfies the requirements it will push an element to the input_queue
      * Supported input:
      *     - Button: Creates a basic button ParamPackage
      *     - HatButton: Creates a basic hat button ParamPackage
      *     - Analog: Creates a basic analog ParamPackage
-     * @param "data": An struct containing all the information needed to create a proper
+     * @param data A struct containing all the information needed to create a proper
      * ParamPackage
      */
     void RegisterButton(const MappingData& data);
 
     /**
-     * If provided data satisfies the requeriments it will push an element to the input_queue
+     * If provided data satisfies the requirements it will push an element to the input_queue
      * Supported input:
      *     - Button, HatButton: Pass the data to RegisterButton
      *     - Analog: Stores the first axis and on the second axis creates a basic stick ParamPackage
-     * @param "data": An struct containing all the information needed to create a proper
-     * ParamPackage
+     * @param data A struct containing all the information needed to create a proper
+     *             ParamPackage
      */
     void RegisterStick(const MappingData& data);
 
     /**
-     * If provided data satisfies the requeriments it will push an element to the input_queue
+     * If provided data satisfies the requirements it will push an element to the input_queue
      * Supported input:
      *     - Button, HatButton: Pass the data to RegisterButton
      *     - Analog: Stores the first two axis and on the third axis creates a basic Motion
      * ParamPackage
      *     - Motion: Creates a basic Motion ParamPackage
-     * @param "data": An struct containing all the information needed to create a proper
-     * ParamPackage
+     * @param data A struct containing all the information needed to create a proper
+     *             ParamPackage
      */
     void RegisterMotion(const MappingData& data);
 
     /**
      * Returns true if driver can be mapped
-     * @param "data": An struct containing all the information needed to create a proper
-     * ParamPackage
+     * @param data A struct containing all the information needed to create a proper
+     *             ParamPackage
      */
     bool IsDriverValid(const MappingData& data) const;
 

src/input_common/input_poller.h

@@ -13,9 +13,6 @@ class Factory;
 
 namespace InputCommon {
 class InputEngine;
-/**
- * An Input factory. It receives input events and forward them to all input devices it created.
- */
 
 class OutputFactory final : public Common::Input::Factory<Common::Input::OutputDevice> {
 public:
@@ -24,10 +21,10 @@ public:
     /**
      * Creates an output device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique ouput device with the parameters specified
+     *               - "guid" text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique output device with the parameters specified
      */
     std::unique_ptr<Common::Input::OutputDevice> Create(
         const Common::ParamPackage& params) override;
@@ -36,6 +33,9 @@ private:
     std::shared_ptr<InputEngine> input_engine;
 };
 
+/**
+ * An Input factory. It receives input events and forward them to all input devices it created.
+ */
 class InputFactory final : public Common::Input::Factory<Common::Input::InputDevice> {
 public:
     explicit InputFactory(std::shared_ptr<InputEngine> input_engine_);
@@ -54,16 +54,16 @@ public:
      * - battery: Contains "battery"
      * - output: Contains "output"
      * @param params contains parameters for creating the device:
-     * @param    - "code": the code of the keyboard key to bind with the input
-     * @param    - "button": same as "code" but for controller buttons
-     * @param    - "hat": similar as "button" but it's a group of hat buttons from SDL
-     * @param    - "axis": the axis number of the axis to bind with the input
-     * @param    - "motion": the motion number of the motion to bind with the input
-     * @param    - "axis_x": same as axis but specifing horizontal direction
-     * @param    - "axis_y": same as axis but specifing vertical direction
-     * @param    - "axis_z": same as axis but specifing forward direction
-     * @param    - "battery": Only used as a placeholder to set the input type
-     * @return an unique input device with the parameters specified
+     *               - "code": the code of the keyboard key to bind with the input
+     *               - "button": same as "code" but for controller buttons
+     *               - "hat": similar as "button" but it's a group of hat buttons from SDL
+     *               - "axis": the axis number of the axis to bind with the input
+     *               - "motion": the motion number of the motion to bind with the input
+     *               - "axis_x": same as axis but specifying horizontal direction
+     *               - "axis_y": same as axis but specifying vertical direction
+     *               - "axis_z": same as axis but specifying forward direction
+     *               - "battery": Only used as a placeholder to set the input type
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> Create(const Common::ParamPackage& params) override;
 
@@ -71,14 +71,14 @@ private:
     /**
      * Creates a button device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "code": the code of the keyboard key to bind with the input
-     * @param    - "button": same as "code" but for controller buttons
-     * @param    - "toggle": press once to enable, press again to disable
-     * @param    - "inverted": inverts the output of the button
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "code": the code of the keyboard key to bind with the input
+     *               - "button": same as "code" but for controller buttons
+     *               - "toggle": press once to enable, press again to disable
+     *               - "inverted": inverts the output of the button
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateButtonDevice(
         const Common::ParamPackage& params);
@@ -86,14 +86,14 @@ private:
     /**
      * Creates a hat button device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "button": the controller hat id to bind with the input
-     * @param    - "direction": the direction id to be detected
-     * @param    - "toggle": press once to enable, press again to disable
-     * @param    - "inverted": inverts the output of the button
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "button": the controller hat id to bind with the input
+     *               - "direction": the direction id to be detected
+     *               - "toggle": press once to enable, press again to disable
+     *               - "inverted": inverts the output of the button
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateHatButtonDevice(
         const Common::ParamPackage& params);
@@ -101,19 +101,19 @@ private:
     /**
      * Creates a stick device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "axis_x": the controller horizontal axis id to bind with the input
-     * @param    - "axis_y": the controller vertical axis id to bind with the input
-     * @param    - "deadzone": the mimimum required value to be detected
-     * @param    - "range": the maximum value required to reach 100%
-     * @param    - "threshold": the mimimum required value to considered pressed
-     * @param    - "offset_x": the amount of offset in the x axis
-     * @param    - "offset_y": the amount of offset in the y axis
-     * @param    - "invert_x": inverts the sign of the horizontal axis
-     * @param    - "invert_y": inverts the sign of the vertical axis
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "axis_x": the controller horizontal axis id to bind with the input
+     *               - "axis_y": the controller vertical axis id to bind with the input
+     *               - "deadzone": the minimum required value to be detected
+     *               - "range": the maximum value required to reach 100%
+     *               - "threshold": the minimum required value to considered pressed
+     *               - "offset_x": the amount of offset in the x axis
+     *               - "offset_y": the amount of offset in the y axis
+     *               - "invert_x": inverts the sign of the horizontal axis
+     *               - "invert_y": inverts the sign of the vertical axis
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateStickDevice(
         const Common::ParamPackage& params);
@@ -121,16 +121,16 @@ private:
     /**
      * Creates an analog device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "axis": the controller axis id to bind with the input
-     * @param    - "deadzone": the mimimum required value to be detected
-     * @param    - "range": the maximum value required to reach 100%
-     * @param    - "threshold": the mimimum required value to considered pressed
-     * @param    - "offset": the amount of offset in the axis
-     * @param    - "invert": inverts the sign of the axis
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "axis": the controller axis id to bind with the input
+     *               - "deadzone": the minimum required value to be detected
+     *               - "range": the maximum value required to reach 100%
+     *               - "threshold": the minimum required value to considered pressed
+     *               - "offset": the amount of offset in the axis
+     *               - "invert": inverts the sign of the axis
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateAnalogDevice(
         const Common::ParamPackage& params);
@@ -138,20 +138,20 @@ private:
     /**
      * Creates a trigger device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "button": the controller hat id to bind with the input
-     * @param    - "direction": the direction id to be detected
-     * @param    - "toggle": press once to enable, press again to disable
-     * @param    - "inverted": inverts the output of the button
-     * @param    - "axis": the controller axis id to bind with the input
-     * @param    - "deadzone": the mimimum required value to be detected
-     * @param    - "range": the maximum value required to reach 100%
-     * @param    - "threshold": the mimimum required value to considered pressed
-     * @param    - "offset": the amount of offset in the axis
-     * @param    - "invert": inverts the sign of the axis
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "button": the controller hat id to bind with the input
+     *               - "direction": the direction id to be detected
+     *               - "toggle": press once to enable, press again to disable
+     *               - "inverted": inverts the output of the button
+     *               - "axis": the controller axis id to bind with the input
+     *               - "deadzone": the minimum required value to be detected
+     *               - "range": the maximum value required to reach 100%
+     *               - "threshold": the minimum required value to considered pressed
+     *               - "offset": the amount of offset in the axis
+     *               - "invert": inverts the sign of the axis
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateTriggerDevice(
         const Common::ParamPackage& params);
@@ -159,23 +159,23 @@ private:
     /**
      * Creates a touch device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "button": the controller hat id to bind with the input
-     * @param    - "direction": the direction id to be detected
-     * @param    - "toggle": press once to enable, press again to disable
-     * @param    - "inverted": inverts the output of the button
-     * @param    - "axis_x": the controller horizontal axis id to bind with the input
-     * @param    - "axis_y": the controller vertical axis id to bind with the input
-     * @param    - "deadzone": the mimimum required value to be detected
-     * @param    - "range": the maximum value required to reach 100%
-     * @param    - "threshold": the mimimum required value to considered pressed
-     * @param    - "offset_x": the amount of offset in the x axis
-     * @param    - "offset_y": the amount of offset in the y axis
-     * @param    - "invert_x": inverts the sign of the horizontal axis
-     * @param    - "invert_y": inverts the sign of the vertical axis
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "button": the controller hat id to bind with the input
+     *               - "direction": the direction id to be detected
+     *               - "toggle": press once to enable, press again to disable
+     *               - "inverted": inverts the output of the button
+     *               - "axis_x": the controller horizontal axis id to bind with the input
+     *               - "axis_y": the controller vertical axis id to bind with the input
+     *               - "deadzone": the minimum required value to be detected
+     *               - "range": the maximum value required to reach 100%
+     *               - "threshold": the minimum required value to considered pressed
+     *               - "offset_x": the amount of offset in the x axis
+     *               - "offset_y": the amount of offset in the y axis
+     *               - "invert_x": inverts the sign of the horizontal axis
+     *               - "invert_y": inverts the sign of the vertical axis
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateTouchDevice(
         const Common::ParamPackage& params);
@@ -183,10 +183,10 @@ private:
     /**
      * Creates a battery device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateBatteryDevice(
         const Common::ParamPackage& params);
@@ -194,21 +194,21 @@ private:
     /**
      * Creates a motion device from the parameters given.
      * @param params contains parameters for creating the device:
-     * @param    - "axis_x": the controller horizontal axis id to bind with the input
-     * @param    - "axis_y": the controller vertical axis id to bind with the input
-     * @param    - "axis_z": the controller fordward axis id to bind with the input
-     * @param    - "deadzone": the mimimum required value to be detected
-     * @param    - "range": the maximum value required to reach 100%
-     * @param    - "offset_x": the amount of offset in the x axis
-     * @param    - "offset_y": the amount of offset in the y axis
-     * @param    - "offset_z": the amount of offset in the z axis
-     * @param    - "invert_x": inverts the sign of the horizontal axis
-     * @param    - "invert_y": inverts the sign of the vertical axis
-     * @param    - "invert_z": inverts the sign of the fordward axis
-     * @param    - "guid": text string for identifing controllers
-     * @param    - "port": port of the connected device
-     * @param    - "pad": slot of the connected controller
-     * @return an unique input device with the parameters specified
+     *               - "axis_x": the controller horizontal axis id to bind with the input
+     *               - "axis_y": the controller vertical axis id to bind with the input
+     *               - "axis_z": the controller forward axis id to bind with the input
+     *               - "deadzone": the minimum required value to be detected
+     *               - "range": the maximum value required to reach 100%
+     *               - "offset_x": the amount of offset in the x axis
+     *               - "offset_y": the amount of offset in the y axis
+     *               - "offset_z": the amount of offset in the z axis
+     *               - "invert_x": inverts the sign of the horizontal axis
+     *               - "invert_y": inverts the sign of the vertical axis
+     *               - "invert_z": inverts the sign of the forward axis
+     *               - "guid": text string for identifying controllers
+     *               - "port": port of the connected device
+     *               - "pad": slot of the connected controller
+     * @returns a unique input device with the parameters specified
      */
     std::unique_ptr<Common::Input::InputDevice> CreateMotionDevice(Common::ParamPackage params);