docs

[wavpack.git] / Codec / Audio / WavPack / Metadata.hs

diff --git a/Codec/Audio/WavPack/Metadata.hs b/Codec/Audio/WavPack/Metadata.hs
index f7dc2a0bc7ac6573ec7282382720d3475bf2dd3c..35864b1b46bc0c9911a6b9d4a04fa2c2e87a038e 100644 (file)
--- a/Codec/Audio/WavPack/Metadata.hs
+++ b/Codec/Audio/WavPack/Metadata.hs
@@ -23,7 +23,8 @@ import Prelude.Unicode
 
 -- | Type class for every metadata sub-blocks.
 class (Binary α, Eq α, Show α, Typeable α) ⇒ Metadata α where
-    -- | Get the metadata ID (mandatory).
+    -- | Get the metadata ID without odd-size bit nor large-block bit
+    -- (mandatory).
     metaID   ∷ α → Word8
     -- | Get the size of metadata (optional).
     metaSize ∷ α → Word32
@@ -100,6 +101,8 @@ instance Show SubBlock where
 -- | Dummy metadata to pad WavPack blocks.
 data Dummy
     = Dummy {
+        -- | Must be less than 2^25 bytes long due to the limitation
+        -- of WavPack specification.
         dumSize ∷ Word32
       }
     deriving (Eq, Show, Typeable)
@@ -115,7 +118,9 @@ instance Binary Dummy where
 -- | Unknown but optional metadata found in the WavPack block.
 data Unknown
     = Unknown {
+        -- | The ID of this unknown metadata.
         unkID   ∷ Word8
+        -- | Raw data; must be less than 2^25 bytes long.
       , unkData ∷ L.ByteString
       }
     deriving (Eq, Show, Typeable)