From 6b1e7b557a11f6bafda5af10622dbf8584871ac9 Mon Sep 17 00:00:00 2001 From: nek0 Date: Wed, 10 Jan 2018 16:58:23 +0100 Subject: [PATCH] documentation --- src/Affection/Subsystems/AffectionJoystick.hs | 8 +++++--- src/Affection/Subsystems/AffectionKeyboard.hs | 8 +++++--- src/Affection/Subsystems/AffectionMouse.hs | 8 +++++--- src/Affection/Subsystems/AffectionWindow.hs | 8 +++++--- src/Affection/Subsystems/Class.hs | 3 +++ 5 files changed, 23 insertions(+), 12 deletions(-) diff --git a/src/Affection/Subsystems/AffectionJoystick.hs b/src/Affection/Subsystems/AffectionJoystick.hs index 9951d1b..30d9578 100644 --- a/src/Affection/Subsystems/AffectionJoystick.hs +++ b/src/Affection/Subsystems/AffectionJoystick.hs @@ -20,11 +20,13 @@ import Foreign.C.Types (CInt(..)) import qualified SDL +-- | Helper function that consumes all Joystick-related 'SDL.EventPayload's +-- and emits appropriate 'JoystickMessage's consumeSDLJoystickEvents :: forall am us. (Participant am us, Mesg am us ~ JoystickMessage) - => am - -> [SDL.EventPayload] - -> Affection us [SDL.EventPayload] + => am -- ^ The message system participant + -> [SDL.EventPayload] -- ^ Incoming events + -> Affection us [SDL.EventPayload] -- ^ Leftover SDL events consumeSDLJoystickEvents am = doConsume where doConsume diff --git a/src/Affection/Subsystems/AffectionKeyboard.hs b/src/Affection/Subsystems/AffectionKeyboard.hs index d73ec1e..9d23df9 100644 --- a/src/Affection/Subsystems/AffectionKeyboard.hs +++ b/src/Affection/Subsystems/AffectionKeyboard.hs @@ -14,11 +14,13 @@ import Control.Monad.IO.Class (liftIO) import qualified SDL +-- | Helper function that consumes all Keyboard-related 'SDL.EventPayload's +-- and emits appropriate 'KeyboardMessage's consumeSDLKeyboardEvents :: forall ak us. (Participant ak us, Mesg ak us ~ KeyboardMessage) - => ak - -> [SDL.EventPayload] - -> Affection us [SDL.EventPayload] + => ak -- ^ The message system participant + -> [SDL.EventPayload] -- ^ Incoming events + -> Affection us [SDL.EventPayload] -- ^ Leftover SDL Events consumeSDLKeyboardEvents ak = doConsume where doConsume [] = return [] diff --git a/src/Affection/Subsystems/AffectionMouse.hs b/src/Affection/Subsystems/AffectionMouse.hs index 7ff73c8..b1ede2c 100644 --- a/src/Affection/Subsystems/AffectionMouse.hs +++ b/src/Affection/Subsystems/AffectionMouse.hs @@ -16,11 +16,13 @@ import Linear.Affine (unP) import qualified SDL +-- | Helper funtion that consumes all Mouse-related 'SDL.Eventpayload's +-- and emits appropriate 'MouseMessage's consumeSDLMouseEvents :: forall am us. (Participant am us, Mesg am us ~ MouseMessage) - => am - -> [SDL.EventPayload] - -> Affection us [SDL.EventPayload] + => am -- ^ The message system participant + -> [SDL.EventPayload] -- ^ Incoming events + -> Affection us [SDL.EventPayload] -- ^ Leftover SDL events consumeSDLMouseEvents am = doConsume where doConsume diff --git a/src/Affection/Subsystems/AffectionWindow.hs b/src/Affection/Subsystems/AffectionWindow.hs index 6e28ff6..e2e3bd5 100644 --- a/src/Affection/Subsystems/AffectionWindow.hs +++ b/src/Affection/Subsystems/AffectionWindow.hs @@ -16,11 +16,13 @@ import Control.Monad.IO.Class (liftIO) import qualified SDL +-- | Helper function that consumes all Window-related 'SDL.EventPayload's +-- and emits appropriate 'WindowMessage's. consumeSDLWindowEvents :: forall aw us. (Participant aw us, Mesg aw us ~ WindowMessage) - => aw - -> [SDL.EventPayload] - -> Affection us [SDL.EventPayload] + => aw -- ^ The message system participant + -> [SDL.EventPayload] -- ^ Incoming events + -> Affection us [SDL.EventPayload] -- ^ Leftover SDL events consumeSDLWindowEvents aw = doConsume where doConsume diff --git a/src/Affection/Subsystems/Class.hs b/src/Affection/Subsystems/Class.hs index 7c52f8e..4509332 100644 --- a/src/Affection/Subsystems/Class.hs +++ b/src/Affection/Subsystems/Class.hs @@ -7,5 +7,8 @@ import Affection.MessageBus import qualified SDL +-- | This class denotes a Subsystem to be part of SDL class SDLSubsystem s us where + -- | Consume the given 'SDL.EventPayload's and return only those not + -- recognised consumeSDLEvents :: s -> [SDL.EventPayload] -> Affection us [SDL.EventPayload]