From: PHO <pho@cielonegro.org>
Date: Wed, 5 Jan 2011 14:50:57 +0000 (+0900)
Subject: docs
X-Git-Url: https://git.cielonegro.org/gitweb.cgi?a=commitdiff_plain;h=e4b72f263a4fc1404ede73b8bbe62ce4e7e2209a;p=wavpack.git

docs
---

diff --git a/Codec/Audio/WavPack/Metadata.hs b/Codec/Audio/WavPack/Metadata.hs
index f7dc2a0..78a99fc 100644
--- a/Codec/Audio/WavPack/Metadata.hs
+++ b/Codec/Audio/WavPack/Metadata.hs
@@ -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)