docs
authorPHO <pho@cielonegro.org>
Wed, 5 Jan 2011 14:50:57 +0000 (23:50 +0900)
committerPHO <pho@cielonegro.org>
Wed, 5 Jan 2011 14:50:57 +0000 (23:50 +0900)
Codec/Audio/WavPack/Metadata.hs

index f7dc2a0bc7ac6573ec7282382720d3475bf2dd3c..78a99fc5e232dd7e168c971d30d1209a80cd92de 100644 (file)
@@ -100,6 +100,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 +117,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)