Merge pull request #581 from IntersectMBO/jeltsch/more-private-haddock-comments

Turn more private API documentation into Haddock comments

Author: jeltsch

test/Test/Database/LSMTree/Internal/Chunk.hs

@@ -38,7 +38,7 @@ tests = testGroup "Test.Database.LSMTree.Internal.Chunk" $
 
 -- * Properties to test
 
-{-
+{-|
     Feeds a freshly created baler a sequence of data portions and ends it
     afterwards, yielding all output.
 -}
@@ -51,7 +51,7 @@ balingOutput minChunkSize food = runST $ do
     remnant <- unsafeEndBaler baler
     return (commonChunks, remnant)
 
-{-
+{-|
     Supplies the output of a complete baler run for constructing a property.
 
     The resulting property additionally provides statistics about the lengths of
@@ -127,7 +127,7 @@ prop_remnantChunkIsSmall (MinChunkSize minChunkSize)
 
 -- * Test case generation and shrinking
 
-{-
+{-|
     The type of minimum chunk sizes.
 
     This type is isomorphic to 'Int' but has a different way of generating test

test/Test/Database/LSMTree/Internal/Vector/Growing.hs

@@ -42,7 +42,7 @@ appendSegment vec (Replicate count val) = append vec count val
 
 -- ** Vector construction
 
-{-
+{-|
     Constructs an ordinary vector by creating a growing vector, appending
     segments to it, and finally freezing it.
 -}
@@ -54,7 +54,7 @@ finalVector initialBufferSize segments = runST $ do
     mapM_ (appendSegment vec) segments
     freeze vec
 
-{-
+{-|
     Supplies the final contents of a growing vector for constructing a property.
 
     The resulting property additionally provides information about the
@@ -129,7 +129,7 @@ shrinkSegment (Replicate count val)
     shrinkNat :: Int -> [Int]
     shrinkNat = shrinkMap getNonNegative NonNegative
 
-{-
+{-|
     A list of segments to be appended to an initially empty vector. 'Segments a'
     is isomorphic to '[Segment a]' but has a special way of generating test
     cases, which avoids skewing with respect to buffer size scaling exponents.