gtk2hs-commit

[<du...@co...>]

Sun May 18 20:49:51 EDT 2008  Peter Gavin <pg...@gm...>
  * gstreamer: more docs for M.S.G.Core.Bus

    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 77
    +  BusClass,
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 84
    -  BusClass,
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 128
    -            => busT
    -            -> IO [BusFlags]
    +            => busT          -- ^ @bus@ - a 'Bus'
    +            -> IO [BusFlags] -- ^ the flags set on @bus@
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 134
    -            => busT
    -            -> [BusFlags]
    +            => busT       -- ^ @bus@ - a 'Bus'
    +            -> [BusFlags] -- ^ the flags to set on @bus@
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 141
    -              => busT
    -              -> [BusFlags]
    +              => busT       -- ^ @bus@ - a 'Bus'
    +              -> [BusFlags] -- ^ the flags to unset on @bus@
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 147
    -busNew :: IO Bus
    +busNew :: IO Bus -- ^ the newly created 'Bus' object
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 153
    -        => busT
    -        -> Message
    -        -> IO Bool
    +        => busT    -- ^ @bus@ - a 'Bus'
    +        -> Message -- ^ @message@ - the message to post
    +        -> IO Bool -- ^ 'True' if the message was posted, or
    +                   --   'False' if the bus is flushing
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 163
    -               => busT
    -               -> IO Bool
    +               => busT    -- ^ @bus@ - a 'Bus'
    +               -> IO Bool -- ^ 'True' if there are messages
    +                          --   on the bus to be handled, otherwise 'False'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 169
    --- | Get the message at the front of the queue.  It will remain on the
    ---   queue.
    +-- | Get the message at the front of the queue.  Any message returned
    +--   will remain on the queue.
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 172
    -        => busT
    -        -> IO (Maybe Message)
    +        => busT               -- ^ @bus@ - a 'Bus'
    +        -> IO (Maybe Message) -- ^ the first 'Message' on the bus, or
    +                              --   'Nothing' if the bus is empty
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 181
    -       => busT
    -       -> IO (Maybe Message)
    +       => busT               -- ^ @bus@ - a 'Bus'
    +       -> IO (Maybe Message) -- ^ the first 'Message' on the bus, or
    +                             --   'Nothing' if the bus is empty
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 191
    -            => busT
    -            -> Maybe ClockTime
    -            -> IO (Maybe Message)
    +            => busT               -- ^ @bus@ - a 'Bus'
    +            -> Maybe ClockTime    -- ^ @timeoutM@ - the time to wait for,
    +                                  --   or 'Nothing' to wait forever
    +            -> IO (Maybe Message) -- ^ the first message recieved, or
    +                                  --   'Nothing' if the timeout has expired
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 207
    -               => busT
    -               -> Bool
    +               => busT  -- ^ @bus@ - a 'Bus'
    +               -> Bool  -- ^ @flushing@ - the new flushing state
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 213
    --- these will leak memory, maybe one day we can set a destroy notifier...
    -
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 233
    --- the following mess is necessary to clean up safely after busSetSyncHandler.
    --- gstreamer doesn't give us a nice way to do this (such as a DestroyNotify)
    +-- the following mess is necessary to clean up the FunPtr after
    +-- busSetSyncHandler.  gstreamer doesn't give us a nice way to do this
    +-- (such as a DestroyNotify pointer in the argument list)
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 287
    -                  => busT
    -                  -> Maybe BusSyncHandler
    +                  => busT                 -- ^ @bus@ - a 'Bus'
    +                  -> Maybe BusSyncHandler -- ^ @busSyncHandlerM@ - the new 'BusSyncHandler'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 305
    -                        => busT
    +                        => busT  -- ^ @bus@ - a 'Bus'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 318
    -               => busT
    -               -> IO Source
    +               => busT      -- ^ @bus@ - a 'Bus'
    +               -> IO Source -- ^ the new event 'Source'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 349
    -            => busT
    -            -> Priority
    -            -> BusFunc
    -            -> IO HandlerId
    +            => busT         -- ^ @bus@ - a 'Bus'
    +            -> Priority     -- ^ @priority@ - the priority of the watch
    +            -> BusFunc      -- ^ @func@ - the action to perform when a message is recieved
    +            -> IO HandlerId -- ^ the event source ID
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 374
    -                              => busT
    +                              => busT  -- ^ @bus@ - a 'Bus'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 396
    -                             => busT
    +                             => busT  -- ^ @bus@ - a 'Bus'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 409
    -                  => busT
    -                  -> Priority
    +                  => busT     -- ^ @bus@ - a 'Bus'
    +                  -> Priority -- ^ @priority@ - the priority of the watch
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 417
    -                     => busT
    +                     => busT  -- ^ @bus@ - a 'Bus'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 438
    -busPoll :: Bus
    -        -> [MessageType]
    -        -> ClockTimeDiff
    +busPoll :: BusClass busT
    +        => busT          -- ^ @bus@ - a 'Bus'
    +        -> [MessageType] -- ^ @events@ - the set of messages to poll for
    +        -> ClockTimeDiff -- ^ @timeout@ - the time to wait, or -1 to wait indefinitely
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 444
    -    {# call bus_poll #} bus
    +    {# call bus_poll #} (toBus bus)
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 451
    -busMessage :: BusClass bus
    -           => Signal bus (Message -> IO ())
    +busMessage :: BusClass busT
    +           => Signal busT (Message -> IO ())
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Bus.chs 463
    -busSyncMessage :: BusClass bus
    -               => Signal bus (Message -> IO ())
    +busSyncMessage :: BusClass busT
    +               => Signal busT (Message -> IO ())