[Gtk2hs-commit] (main branch): gstreamer: more docs in M.S.G.Core.Caps

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

Sun May 18 20:52:33 EDT 2008  Peter Gavin <pg...@gm...>
  * gstreamer: more docs in M.S.G.Core.Caps

    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 106
    --- | Returns the number of structures contained in the 'Caps'.
    -capsSize :: Caps
    -         -> Word
    +-- | Get the number of structures contained in the 'Caps'.
    +capsSize :: Caps -- ^ @caps@ - a 'Caps'
    +         -> Word -- ^ the number of structures contained in the 'Caps'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 112
    --- | Returns the 'Structure' at the given index.
    -capsGetStructure :: Caps
    -                 -> Word
    -                 -> Maybe Structure
    +-- | Get the 'Structure' at the given index.
    +capsGetStructure :: Caps            -- ^ @caps@ - a 'Caps'
    +                 -> Word            -- ^ @index@ - the index of the 'Structure'
    +                 -> Maybe Structure -- ^ the 'Structure' at the given index, or 'Nothing'
    +                                    --   if @index@ is invalid
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 122
    --- | Returns a new 'Caps' containing only the 'Structure' at the given
    +-- | Create a new 'Caps' containing only the 'Structure' at the given
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 124
    -capsCopyNth :: Caps
    -            -> Word
    -            -> Maybe Caps
    +capsCopyNth :: Caps       -- ^ @caps@ - a 'Caps'
    +            -> Word       -- ^ @index@ - the index of the 'Structure'
    +            -> Maybe Caps -- ^ the new 'Caps', or 'Nothing'
    +                          --   if @index@ is invalid
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 133
    --- | Returns 'True' if the caps represents no media formats.
    -capsIsEmpty :: Caps
    -            -> Bool
    +-- | Determine whether @caps@ represents no media formats.
    +capsIsEmpty :: Caps -- ^ @caps@ - a 'Caps'
    +            -> Bool -- ^ 'True' if @caps@ is empty, otherwise 'False'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 140
    --- | Returns 'True' if the caps is fixed.
    -capsIsFixed :: Caps
    -            -> Bool
    +-- | Determine whether the @caps@ is fixed; that is, if it has exactly
    +--   one structure, and each field in the structure describes a fixed type.
    +capsIsFixed :: Caps -- ^ @caps@ - a 'Caps'
    +            -> Bool -- ^ 'True' if @caps@ is fixed, otherwise 'False'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 149
    -capsIsEqual :: Caps
    -            -> Caps
    -            -> Bool
    +--   [_$_]
    +--   This function does not work reliably if optional properties for
    +--   'Caps' are included on one 'Caps' but omitted on the other.
    +capsIsEqual :: Caps -- ^ @caps1@ - the first 'Caps'
    +            -> Caps -- ^ @caps2@ - the second 'Caps'
    +            -> Bool -- ^ 'True' if both 'Caps' represent the same set
    +                    --   of capabilities.
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 165
    -capsIsEqualFixed :: Caps
    -                 -> Caps
    -                 -> Bool
    +capsIsEqualFixed :: Caps -- ^ @caps1@ - the first 'Caps'
    +                 -> Caps -- ^ @caps2@ - the second 'Caps'
    +                 -> Bool -- ^ 'True' if both 'Caps' represent the same set
    +                         --   of capabilities
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 176
    -capsIsAlwaysCompatible :: Caps
    -                       -> Caps
    -                       -> Bool
    +capsIsAlwaysCompatible :: Caps -- ^ @caps1@ - the first 'Caps'
    +                       -> Caps -- ^ @caps2@ - the second 'Caps'
    +                       -> Bool -- ^ 'True' if @caps1@ is a subset of @caps2@, otherwise 'False'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 188
    -capsIsSubset :: Caps
    -             -> Caps
    -             -> Bool
    +capsIsSubset :: Caps -- ^ @caps1@ - the first 'Caps'
    +             -> Caps -- ^ @caps2@ - the second 'Caps'
    +             -> Bool -- ^ 'True' if @caps1@ is a subset of @caps2@, otherwise 'False'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 197
    -capsIntersect :: Caps
    -              -> Caps
    -              -> Caps
    +capsIntersect :: Caps -- ^ @caps1@ - the first 'Caps'
    +              -> Caps -- ^ @caps2@ - the second 'Caps'
    +              -> Caps -- ^ a new 'Caps' containing all capabilities present
    +                      --   in both @caps1@ and @caps2@
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 209
    -capsUnion :: Caps
    -          -> Caps
    -          -> Caps
    +capsUnion :: Caps -- ^ @caps1@ - the first 'Caps'
    +          -> Caps -- ^ @caps2@ - the second 'Caps'
    +          -> Caps -- ^ a new 'Caps' containing all capabilities present
    +                  --   in either @caps1@ and @caps2@
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 220
    -capsSubtract :: Caps
    -             -> Caps
    -             -> Caps
    +capsSubtract :: Caps -- ^ @caps1@ - the first 'Caps'
    +             -> Caps -- ^ @caps2@ - the second 'Caps'
    +             -> Caps -- ^ a new 'Caps' containing all capabilities present
    +                     --   in @caps1@ but not @caps2@
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 231
    -capsNormalize :: Caps
    -              -> Caps
    +capsNormalize :: Caps -- ^ @caps@ - a 'Caps'
    +              -> Caps -- ^ the new, normalized 'Caps'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 239
    -capsToString :: Caps
    -             -> String
    +capsToString :: Caps   -- ^ @caps@ - a 'Caps'
    +             -> String -- ^ the string representation of 'Caps'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 246
    -capsFromString :: String
    -               -> Maybe Caps
    +capsFromString :: String     -- ^ @string@ - the string representation of a 'Caps'
    +               -> Maybe Caps -- ^ the new 'Caps', or 'Nothing' if @string@ is invalid
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 272
    -capsCreate :: CapsM a
    -           -> (Caps, a)
    -capsCreate action =
    +capsCreate :: CapsM a   -- ^ @mutate@ - the mutating action
    +           -> (Caps, a) -- ^ the new 'Caps' and the action's result
    +capsCreate mutate =
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 277
    -        action
    +        mutate
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 280
    -capsModify :: Caps
    -           -> CapsM a
    -           -> (Caps, a)
    -capsModify caps action =
    -    marshalCapsModify ({# call caps_copy #} caps) action
    +capsModify :: Caps      -- ^ @caps@ - the 'Caps' to modify
    +           -> CapsM a   -- ^ @mutate@ - the mutating action
    +           -> (Caps, a) -- ^ the new 'Caps' and the action's result
    +capsModify caps mutate =
    +    marshalCapsModify ({# call caps_copy #} caps) mutate
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 287
    -capsAppendStructure :: Structure
    +capsAppendStructure :: Structure -- ^ @structure@ - the 'Structure' to append to the current 'Caps'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 299
    -capsMergeStructure :: Structure
    +capsMergeStructure :: Structure -- ^ @structure@ - the 'Structure' to merge with the current 'Caps'
    hunk ./gstreamer/Media/Streaming/GStreamer/Core/Caps.chs 310
    -capsRemoveStructure :: Word
    +capsRemoveStructure :: Word     -- ^ @idx@ - the index of the 'Structure' to remove