Browse Source

Haddokc runs cleanly

Marcos Dumay de Medeiros 8 years ago
parent
commit
0817d283a6
1 changed files with 25 additions and 10 deletions
  1. 25 10
      src/Walrus/Backend/Metadata.hs

+ 25 - 10
src/Walrus/Backend/Metadata.hs

@@ -74,27 +74,42 @@ data DeliverData = DeliverData {clientName :: ByteString,
 data HandleData = HandleAddress Address |
                   HandleResponse (Address, Response) |
                   HandleOk deriving (Show, Ord, Eq)
+
+{- |
+Data for fetching resource:
+
+@
+FetchRescData clientName account offset size target_or_error
+@
+-}
 data FetchRescData = FetchRescData
-  -- | Client name
+  -- Client name
   ByteString
-  -- | From account
+  -- From account
   Account
-  -- | Offset
+  -- Offset
   Int
-  -- | Size
+  -- Size
   Int
-  -- | Target or fetch error
+  -- Target or fetch error
   HandleData deriving (Show, Ord, Eq)
+{- |
+Data for fetching headers:
+
+@
+FetchHdrData clientName account onlyHeaders query
+@
+-}
 data FetchHdrData = FetchHdrData
-  -- | Client name
+  -- Client name
   ByteString
-  -- | From account
+  -- From account
   Account
-  -- | Only headers
+  -- Only headers
   Bool
-  -- | Query
+  -- Query
   FtchQuery
-  -- | Target or fetch error
+  -- Target or fetch error
   HandleData deriving (Show, Ord, Eq)
 
 makeLenses ''ClientIdentity