Sat Aug 23 22:01:13 EDT 2008 Peter Gavin <pg...@gm...>
* gstreamer: M.S.G.Core.Format: document everything; remove formatsContains as it's pretty redundant
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 43
- formatsContains,
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 57
-formatGetName :: Format
- -> IO String
+-- | Get a printable name for the given format.
+formatGetName :: Format -- ^ @format@ - a format
+ -> IO String -- ^ the name of the format
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 65
-formatToQuark :: Format
- -> IO Quark
+-- | Get the unique quark for the given format.
+formatToQuark :: Format -- ^ @format@ - a format
+ -> IO Quark -- ^ the unique quark for the format
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 71
-formatRegister :: String
- -> String
- -> IO Format
+-- | Create a new format based on the given nickname, or register a new format with that nickname.
+formatRegister :: String -- ^ @nick@ - the nickname for the format
+ -> String -- ^ @description@ - the description for the format
+ -> IO Format -- ^ the format with the given nickname
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 81
-formatGetByNick :: String
- -> IO Format
+-- | Get the format with the given nickname, or 'FormatUndefined' if
+-- no format by that nickname was found.
+formatGetByNick :: String -- ^ @nick@ - the nickname for the format
+ -> IO Format -- ^ the format with the given nickname,
+ -- or 'FormatUndefined' if it was not found
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 90
-formatsContains :: [Format]
- -> Format
- -> IO Bool
-formatsContains formats format =
- liftM toBool $ [_$_]
- withArray0 0 (map cFromEnum formats) $ \cFormats ->
- {# call formats_contains #} cFormats $ cFromEnum format
-
-formatGetDetails :: Format
- -> IO FormatDefinition
+-- | Get the given format's definition.
+formatGetDetails :: Format -- ^ @format@ - a format
+ -> IO (Maybe FormatDefinition) -- ^ the definition for the given format, or [_$_]
+ -- 'Nothing' if the format was not found
hunk ./gstreamer/Media/Streaming/GStreamer/Core/Format.chs 98
+-- | Get an Iterator over all registered formats.
|
