diff options
author | Lioncash <mathew1800@gmail.com> | 2021-12-14 02:31:57 +0100 |
---|---|---|
committer | Lioncash <mathew1800@gmail.com> | 2021-12-14 02:31:59 +0100 |
commit | 6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a (patch) | |
tree | 04bd3a494d3745e050daa9baf82229cd14aedd90 /src/input_common/input_mapping.h | |
parent | input_poller: Remove several unnecessary @param tags (diff) | |
download | yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.tar yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.tar.gz yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.tar.bz2 yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.tar.lz yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.tar.xz yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.tar.zst yuzu-6497fbfa96d7c9ee5e0a18d6eccc9cc137991d1a.zip |
Diffstat (limited to 'src/input_common/input_mapping.h')
-rw-r--r-- | src/input_common/input_mapping.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/src/input_common/input_mapping.h b/src/input_common/input_mapping.h index 44eb8ad9a..93564b5f8 100644 --- a/src/input_common/input_mapping.h +++ b/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; |