Merge pull request #27 from mauke/hapytex-documentation/module-documentation

fix the documentation of the Data.Default module

Author: mauke

data-default-class/Data/Default/Class.hs

@@ -41,16 +41,21 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 {-# LANGUAGE DefaultSignatures, TypeOperators, FlexibleContexts #-}
 #endif
 
+{-|
+Module      : Data.Default.Class
+Description : Defines a class for types with a default value.
+
+This module defines a class for types with a default value.
+It also defines 'Default' instances for the types 'Int', 'Int8',
+'Int16', 'Int32', 'Int64', 'Word', 'Word8', 'Word16', 'Word32', 'Word64',
+'Integer', 'Float', 'Double', 'Ratio', 'Complex', 'CShort', 'CUShort',
+'CInt', 'CUInt', 'CLong', 'CULong', 'CLLong', 'CULLong', 'CPtrdiff',
+'CSize', 'CSigAtomic', 'CIntPtr', 'CUIntPtr', 'CIntMax', 'CUIntMax',
+'CClock', 'CTime', 'CUSeconds', 'CSUSeconds', 'CFloat', 'CDouble', '(->)',
+'IO', 'Maybe', '()', '[]', 'Ordering', 'Any', 'All', 'Last', 'First', 'Sum',
+'Product', 'Endo', 'Dual', and tuples.
+-}
 module Data.Default.Class (
--- | This module defines a class for types with a default value.
--- It also defines 'Default' instances for the types 'Int', 'Int8',
--- 'Int16', 'Int32', 'Int64', 'Word', 'Word8', 'Word16', 'Word32', 'Word64',
--- 'Integer', 'Float', 'Double', 'Ratio', 'Complex', 'CShort', 'CUShort',
--- 'CInt', 'CUInt', 'CLong', 'CULong', 'CLLong', 'CULLong', 'CPtrdiff',
--- 'CSize', 'CSigAtomic', 'CIntPtr', 'CUIntPtr', 'CIntMax', 'CUIntMax',
--- 'CClock', 'CTime', 'CUSeconds', 'CSUSeconds', 'CFloat', 'CDouble', '(->)',
--- 'IO', 'Maybe', '()', '[]', 'Ordering', 'Any', 'All', 'Last', 'First', 'Sum',
--- 'Product', 'Endo', 'Dual', and tuples.
     Default(..)
 ) where
 

data-default-instances-base/Data/Default/Instances/Base.hs

@@ -33,9 +33,13 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 -}
 
-module Data.Default.Instances.Base (
--- | This module reexports the 'Data.Default.Class.Default' instances from the
--- "Data.Default.Class" module.
-) where
+{-|
+Module      : Data.Default.Instances.Base
+Description : Reëxports the instances from the "Data.Default.Class" module.
+
+This module reëxports the 'Data.Default.Class.Default' instances from the
+"Data.Default.Class" module.
+-}
+module Data.Default.Instances.Base () where
 
 import Data.Default.Class ()

data-default-instances-containers/Data/Default/Instances/Containers.hs

@@ -35,10 +35,14 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
-module Data.Default.Instances.Containers (
--- | This module defines 'Default' instances for the types 'S.Set', 'M.Map',
--- 'IntMap', 'IntSet', 'Seq', and 'Tree'.
-) where
+{-|
+Module      : Data.Default.Instances.Containers
+Description : Defines 'Default' instances for container types.
+
+This module defines 'Default' instances for the types 'S.Set', 'M.Map',
+'IntMap', 'IntSet', 'Seq', and 'Tree'.
+-}
+module Data.Default.Instances.Containers () where
 
 import Data.Default.Class
 import Data.Monoid (mempty)

data-default-instances-dlist/Data/Default/Instances/DList.hs

@@ -35,9 +35,13 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
-module Data.Default.Instances.DList (
--- | This module defines 'Default' instances for the type 'DList'.
-) where
+{-|
+Module      : Data.Default.Instances.DList
+Description : Defines 'Default' instances for the type 'DList'.
+
+This module defines 'Default' instances for the type 'DList'.
+-}
+module Data.Default.Instances.DList () where
 
 import Data.Default.Class
 import Data.DList

data-default-instances-old-locale/Data/Default/Instances/OldLocale.hs

@@ -35,9 +35,13 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 {-# OPTIONS_GHC -fno-warn-orphans #-}
 
-module Data.Default.Instances.OldLocale (
--- | This module defines 'Default' instances for the type 'TimeLocale'.
-) where
+{-|
+Module      : Data.Default.Instances.OldLocale
+Description : Defines 'Default' instances for the type 'TimeLocale'.
+
+This module defines 'Default' instances for the type 'TimeLocale'.
+-}
+module Data.Default.Instances.OldLocale () where
 
 import Data.Default.Class
 import System.Locale

data-default/Data/Default.hs

@@ -33,10 +33,15 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 -}
 
+{-|
+Module      : Data.Default
+Description : Defines a class for types with a default value.
+
+This module defines a class for types with a default value. Instances are
+provided for '()', 'Data.Set.Set', 'Data.Map.Map', 'Int', 'Integer',
+'Float', 'Double', and many others (see below).
+-}
 module Data.Default (
--- | This module defines a class for types with a default value. Instances are
--- provided for '()', 'Data.Set.Set', 'Data.Map.Map', 'Int', 'Integer',
--- 'Float', 'Double', and many others (see below).
     Default(..)
 ) where