Add haddocks for constructors

src/Data/ByteArray/Builder/Bounded/Unsafe.hs

@@ -28,8 +28,11 @@ import Data.Primitive (MutableByteArray(..))
 newtype Builder :: Nat -> Type where
    Builder ::
         (forall s. MutableByteArray# s -> Int# -> State# s -> (# State# s, Int# #)) 
+        -- ^ This function takes a buffer, an offset, and a number of remaining bytes.
+        --   It returns the new offset.
      -> Builder n
    
+
 -- | Constructor for 'Builder' that works on a function with lifted
 -- arguments instead of unlifted ones. This is just as unsafe as the
 -- actual constructor.

src/Data/ByteArray/Builder/Unsafe.hs

@@ -31,10 +31,11 @@ import qualified Data.ByteArray.Builder.Bounded.Unsafe as UnsafeBounded
 
 -- | An unmaterialized sequence of bytes that may be pasted
 -- into a mutable byte array.
-newtype Builder = Builder
+newtype Builder
-  -- This functions takes an offset and a number of remaining bytes
+  = Builder (forall s. MutableByteArray# s -> Int# -> Int# -> State# s -> (# State# s, Int# #))
-  -- and returns the new offset.
+    -- ^ This function takes a buffer, an offset, and a number of remaining bytes.
-  (forall s. MutableByteArray# s -> Int# -> Int# -> State# s -> (# State# s, Int# #))
+    --   It returns the new offset (should be greater than the old offset), or if
+    --   there was not enough space left in buffer, it returns -1.
 
 instance IsString Builder where
   {-# inline fromString #-}