Просмотр исходного кода

input_common/sdl/sdl_impl: Move documentation comments to header where applicable

Places the documentation comments with the rest of SDLState's member
function documentation.
Lioncash 7 лет назад
Родитель
Сommit
cfac942e63
2 измененных файлов с 6 добавлено и 7 удалено
  1. 0 7
      src/input_common/sdl/sdl_impl.cpp
  2. 6 0
      src/input_common/sdl/sdl_impl.h

+ 0 - 7
src/input_common/sdl/sdl_impl.cpp

@@ -131,9 +131,6 @@ private:
     mutable std::mutex mutex;
     mutable std::mutex mutex;
 };
 };
 
 
-/**
- * Get the nth joystick with the corresponding GUID
- */
 std::shared_ptr<SDLJoystick> SDLState::GetSDLJoystickByGUID(const std::string& guid, int port) {
 std::shared_ptr<SDLJoystick> SDLState::GetSDLJoystickByGUID(const std::string& guid, int port) {
     std::lock_guard lock{joystick_map_mutex};
     std::lock_guard lock{joystick_map_mutex};
     const auto it = joystick_map.find(guid);
     const auto it = joystick_map.find(guid);
@@ -149,10 +146,6 @@ std::shared_ptr<SDLJoystick> SDLState::GetSDLJoystickByGUID(const std::string& g
     return joystick_map[guid].emplace_back(std::move(joystick));
     return joystick_map[guid].emplace_back(std::move(joystick));
 }
 }
 
 
-/**
- * Check how many identical joysticks (by guid) were connected before the one with sdl_id and so tie
- * it to a SDLJoystick with the same guid and that port
- */
 std::shared_ptr<SDLJoystick> SDLState::GetSDLJoystickBySDLID(SDL_JoystickID sdl_id) {
 std::shared_ptr<SDLJoystick> SDLState::GetSDLJoystickBySDLID(SDL_JoystickID sdl_id) {
     auto sdl_joystick = SDL_JoystickFromInstanceID(sdl_id);
     auto sdl_joystick = SDL_JoystickFromInstanceID(sdl_id);
     const std::string guid = GetGUID(sdl_joystick);
     const std::string guid = GetGUID(sdl_joystick);

+ 6 - 0
src/input_common/sdl/sdl_impl.h

@@ -34,7 +34,13 @@ public:
     /// Handle SDL_Events for joysticks from SDL_PollEvent
     /// Handle SDL_Events for joysticks from SDL_PollEvent
     void HandleGameControllerEvent(const SDL_Event& event);
     void HandleGameControllerEvent(const SDL_Event& event);
 
 
+    /// Get the nth joystick with the corresponding GUID
     std::shared_ptr<SDLJoystick> GetSDLJoystickBySDLID(SDL_JoystickID sdl_id);
     std::shared_ptr<SDLJoystick> GetSDLJoystickBySDLID(SDL_JoystickID sdl_id);
+
+    /**
+     * Check how many identical joysticks (by guid) were connected before the one with sdl_id and so
+     * tie it to a SDLJoystick with the same guid and that port
+     */
     std::shared_ptr<SDLJoystick> GetSDLJoystickByGUID(const std::string& guid, int port);
     std::shared_ptr<SDLJoystick> GetSDLJoystickByGUID(const std::string& guid, int port);
 
 
     /// Get all DevicePoller that use the SDL backend for a specific device type
     /// Get all DevicePoller that use the SDL backend for a specific device type