From 5dd34767eeb152132d89eddb2e970af368d3b1ba Mon Sep 17 00:00:00 2001 From: Jens Nolte <git@queezle.net> Date: Wed, 15 Dec 2021 15:50:48 +0100 Subject: [PATCH] Adjust export lists and documentation --- src/Quasar/Wayland/Protocol.hs | 5 ++++- src/Quasar/Wayland/Protocol/Core.hs | 11 ++++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/Quasar/Wayland/Protocol.hs b/src/Quasar/Wayland/Protocol.hs index c3f9e73..3599538 100644 --- a/src/Quasar/Wayland/Protocol.hs +++ b/src/Quasar/Wayland/Protocol.hs @@ -3,7 +3,7 @@ module Quasar.Wayland.Protocol ( -- | This module exports everything required to implement Wayland interfaces generated by -- "Quasar.Wayland.Protocol.TH". - Object, + Object(objectProtocol), setEventHandler, setRequestHandler, setMessageHandler, @@ -12,6 +12,7 @@ module Quasar.Wayland.Protocol ( -- ** Wayland types Fixed(..), WlString(..), + toString, -- ** Protocol execution ProtocolHandle, @@ -24,6 +25,7 @@ module Quasar.Wayland.Protocol ( WireCallbackFailed(..), ParserFailed(..), ProtocolException(..), + ProtocolUsageError(..), MaximumIdReached(..), ServerError(..), @@ -32,6 +34,7 @@ module Quasar.Wayland.Protocol ( interfaceName, Side(..), IsSide, + IsInterfaceSide, -- * wl_display interface handleWlDisplayError, diff --git a/src/Quasar/Wayland/Protocol/Core.hs b/src/Quasar/Wayland/Protocol/Core.hs index bcba4fb..412705f 100644 --- a/src/Quasar/Wayland/Protocol/Core.hs +++ b/src/Quasar/Wayland/Protocol/Core.hs @@ -16,7 +16,7 @@ module Quasar.Wayland.Protocol.Core ( interfaceName, IsInterfaceSide(..), IsInterfaceHandler(..), - Object(objectId), + Object(objectProtocol), setEventHandler, setRequestHandler, setMessageHandler, @@ -53,6 +53,7 @@ module Quasar.Wayland.Protocol.Core ( WireCallbackFailed(..), ParserFailed(..), ProtocolException(..), + ProtocolUsageError(..), MaximumIdReached(..), ServerError(..), @@ -512,10 +513,10 @@ takeOutbox protocol = runProtocolTransaction protocol do pure sendData --- | Create an object. The caller is responsible for sending the 'NewId' immediately (exactly once; in the same STM --- transaction; before using the object). +-- | Create an object. The caller is responsible for sending the 'NewId' immediately (exactly once and before using the +-- object). -- --- Exported for use in TH generated code. +-- For use in generated code. newObject :: forall s i. IsInterfaceSide s i => Maybe (MessageHandler s i) @@ -540,7 +541,7 @@ newObject messageHandler = do -- | Create an object from a received id. The caller is responsible for using a 'NewId' exactly once while handling an -- incoming message -- --- Exported for use in TH generated code. +-- For use in generated code. newObjectFromId :: forall s i. IsInterfaceSide s i => Maybe (MessageHandler s i) -- GitLab