Skip to content

Commit a312e1e

Browse files
KommuSoftmauke
authored andcommitted
fix module documentation for the other packages
1 parent 81924e4 commit a312e1e

File tree

6 files changed

+60
-24
lines changed
  • data-default-class/Data/Default
  • data-default-instances-base/Data/Default/Instances
  • data-default-instances-containers/Data/Default/Instances
  • data-default-instances-dlist/Data/Default/Instances
  • data-default-instances-old-locale/Data/Default/Instances
  • data-default/Data

6 files changed

+60
-24
lines changed

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

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,24 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4141
{-# LANGUAGE DefaultSignatures, TypeOperators, FlexibleContexts #-}
4242
#endif
4343

44+
{-|
45+
Module : Data.Default.Class
46+
Description : A module that defines a class for types with a default value.
47+
Maintainer : Lukas Mai
48+
Stability : experimental
49+
Portability : POSIX
50+
51+
This module defines a class for types with a default value.
52+
It also defines 'Default' instances for the types 'Int', 'Int8',
53+
'Int16', 'Int32', 'Int64', 'Word', 'Word8', 'Word16', 'Word32', 'Word64',
54+
'Integer', 'Float', 'Double', 'Ratio', 'Complex', 'CShort', 'CUShort',
55+
'CInt', 'CUInt', 'CLong', 'CULong', 'CLLong', 'CULLong', 'CPtrdiff',
56+
'CSize', 'CSigAtomic', 'CIntPtr', 'CUIntPtr', 'CIntMax', 'CUIntMax',
57+
'CClock', 'CTime', 'CUSeconds', 'CSUSeconds', 'CFloat', 'CDouble', '(->)',
58+
'IO', 'Maybe', '()', '[]', 'Ordering', 'Any', 'All', 'Last', 'First', 'Sum',
59+
'Product', 'Endo', 'Dual', and tuples.
60+
-}
4461
module Data.Default.Class (
45-
-- | This module defines a class for types with a default value.
46-
-- It also defines 'Default' instances for the types 'Int', 'Int8',
47-
-- 'Int16', 'Int32', 'Int64', 'Word', 'Word8', 'Word16', 'Word32', 'Word64',
48-
-- 'Integer', 'Float', 'Double', 'Ratio', 'Complex', 'CShort', 'CUShort',
49-
-- 'CInt', 'CUInt', 'CLong', 'CULong', 'CLLong', 'CULLong', 'CPtrdiff',
50-
-- 'CSize', 'CSigAtomic', 'CIntPtr', 'CUIntPtr', 'CIntMax', 'CUIntMax',
51-
-- 'CClock', 'CTime', 'CUSeconds', 'CSUSeconds', 'CFloat', 'CDouble', '(->)',
52-
-- 'IO', 'Maybe', '()', '[]', 'Ordering', 'Any', 'All', 'Last', 'First', 'Sum',
53-
-- 'Product', 'Endo', 'Dual', and tuples.
5462
Default(..)
5563
) where
5664

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,16 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3333
3434
-}
3535

36-
module Data.Default.Instances.Base (
37-
-- | This module reexports the 'Data.Default.Class.Default' instances from the
38-
-- "Data.Default.Class" module.
39-
) where
36+
{-|
37+
Module : Data.Default.Default.Instances.Base
38+
Description : A module that reexports the instance from the 'Data.Default.Class' module.
39+
Maintainer : Lukas Mai
40+
Stability : experimental
41+
Portability : POSIX
42+
43+
This module reexports the 'Data.Default.Class.Default' instances from the
44+
'Data.Default.Class' module.
45+
-}
46+
module Data.Default.Instances.Base () where
4047

4148
import Data.Default.Class ()

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

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,17 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3535

3636
{-# OPTIONS_GHC -fno-warn-orphans #-}
3737

38-
module Data.Default.Instances.Containers (
39-
-- | This module defines 'Default' instances for the types 'S.Set', 'M.Map',
40-
-- 'IntMap', 'IntSet', 'Seq', and 'Tree'.
41-
) where
38+
{-|
39+
Module : Data.Default.Default.Instances.Containers
40+
Description : A module that defines 'Default' instances for container types.
41+
Maintainer : Lukas Mai
42+
Stability : experimental
43+
Portability : POSIX
44+
45+
This module defines 'Default' instances for the types 'S.Set', 'M.Map',
46+
'IntMap', 'IntSet', 'Seq', and 'Tree'.
47+
-}
48+
module Data.Default.Instances.Containers () where
4249

4350
import Data.Default.Class
4451
import Data.Monoid (mempty)

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,16 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3535

3636
{-# OPTIONS_GHC -fno-warn-orphans #-}
3737

38-
module Data.Default.Instances.DList (
39-
-- | This module defines 'Default' instances for the type 'DList'.
40-
) where
38+
{-|
39+
Module : Data.Default.Default.Instances.DList
40+
Description : A module that defines 'Default' instances for the type 'DList'.
41+
Maintainer : Lukas Mai
42+
Stability : experimental
43+
Portability : POSIX
44+
45+
This module defines 'Default' instances for the type 'DList'.
46+
-}
47+
module Data.Default.Instances.DList () where
4148

4249
import Data.Default.Class
4350
import Data.DList

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,16 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3535

3636
{-# OPTIONS_GHC -fno-warn-orphans #-}
3737

38-
module Data.Default.Instances.OldLocale (
39-
-- | This module defines 'Default' instances for the type 'TimeLocale'.
40-
) where
38+
{-|
39+
Module : Data.Default.Default.Instances.OldLocale
40+
Description : A module that defines 'Default' instances for the type 'TimeLocale'.
41+
Maintainer : Lukas Mai
42+
Stability : experimental
43+
Portability : POSIX
44+
45+
This module defines 'Default' instances for the type 'TimeLocale'.
46+
-}
47+
module Data.Default.Instances.OldLocale () where
4148

4249
import Data.Default.Class
4350
import System.Locale

data-default/Data/Default.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3535

3636
{-|
3737
Module : Data.Default
38-
Description : A module that a class for types with a default value.
38+
Description : A module that defines a class for types with a default value.
3939
Maintainer : Lukas Mai
4040
Stability : experimental
4141
Portability : POSIX

0 commit comments

Comments
 (0)