From 9e890aa2b5b47b5ad55aa8e861401e410bbb498a Mon Sep 17 00:00:00 2001 From: George Wilson Date: Mon, 29 Oct 2018 11:24:37 +1000 Subject: [PATCH] Add module headers and some other miscellanous docs --- digit.cabal | 2 +- src/Data/Digit.hs | 10 ++++++++++ src/Data/Digit/Binary.hs | 16 ++++++++++++++-- src/Data/Digit/Char.hs | 10 ++++++++++ src/Data/Digit/Class/D0.hs | 11 +++++++++++ src/Data/Digit/Class/D1.hs | 11 +++++++++++ src/Data/Digit/Class/D2.hs | 11 +++++++++++ src/Data/Digit/Class/D3.hs | 11 +++++++++++ src/Data/Digit/Class/D4.hs | 11 +++++++++++ src/Data/Digit/Class/D5.hs | 11 +++++++++++ src/Data/Digit/Class/D6.hs | 11 +++++++++++ src/Data/Digit/Class/D7.hs | 11 +++++++++++ src/Data/Digit/Class/D8.hs | 11 +++++++++++ src/Data/Digit/Class/D9.hs | 11 +++++++++++ src/Data/Digit/Class/LowerCase.hs | 10 ++++++++++ src/Data/Digit/Class/MixedCase.hs | 10 ++++++++++ src/Data/Digit/Class/UpperCase.hs | 10 ++++++++++ src/Data/Digit/Decimal.hs | 10 ++++++++++ src/Data/Digit/Enum.hs | 10 ++++++++++ src/Data/Digit/Hexadecimal/LowerCase.hs | 10 ++++++++++ src/Data/Digit/Hexadecimal/MixedCase.hs | 10 ++++++++++ src/Data/Digit/Hexadecimal/UpperCase.hs | 10 ++++++++++ src/Data/Digit/Integral.hs | 10 ++++++++++ src/Data/Digit/Natural.hs | 10 ++++++++++ src/Data/Digit/Octal.hs | 10 ++++++++++ 25 files changed, 255 insertions(+), 3 deletions(-) diff --git a/digit.cabal b/digit.cabal index a51e855..12412f1 100644 --- a/digit.cabal +++ b/digit.cabal @@ -5,7 +5,7 @@ license-file: LICENCE author: Queensland Functional Programming Lab maintainer: Queensland Functional Programming Lab copyright: Copyright (C) 2010-2016 NICTA Limited - Copyright (c) 2017, Commonwealth Scientific and Industrial Research Organisation (CSIRO) ABN 41 687 119 230. + Copyright (c) 2017-2018, Commonwealth Scientific and Industrial Research Organisation (CSIRO) ABN 41 687 119 230. synopsis: A data-type representing digits 0-9 and other combinations category: Data homepage: https://github.com/qfpl/digit diff --git a/src/Data/Digit.hs b/src/Data/Digit.hs index 612a8df..19467a4 100644 --- a/src/Data/Digit.hs +++ b/src/Data/Digit.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit ( module Data.Digit.Binary , module Data.Digit.Decimal diff --git a/src/Data/Digit/Binary.hs b/src/Data/Digit/Binary.hs index 601afa5..97cb980 100644 --- a/src/Data/Digit/Binary.hs +++ b/src/Data/Digit/Binary.hs @@ -2,6 +2,16 @@ {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE TemplateHaskell #-} +{-| +Module : Data.Digit.Binary +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Binary( BinDigit(..) , BinaryNoZero @@ -24,6 +34,7 @@ import Text.Parser.Combinators((), choice) import Data.Digit.Class.D0 import Data.Digit.Class.D1 +-- | A single bit. Either zero or one. data BinDigit = BinDigit0 | BinDigit1 @@ -34,8 +45,8 @@ makePrisms ''BinDigit instance D0 BinDigit where; d0 = _BinDigit0 instance D1 BinDigit where; d1 = _BinDigit1 -type BinaryNoZero d = - D1 d +type BinaryNoZero = + D1 parseBinaryNoZero :: (BinaryNoZero d, CharParsing p) => @@ -43,6 +54,7 @@ parseBinaryNoZero :: parseBinaryNoZero = parse1 "BinaryNoZero" +-- | A constraint for bits type Binary d = (D0 d, BinaryNoZero d) diff --git a/src/Data/Digit/Char.hs b/src/Data/Digit/Char.hs index ca4e7a8..afbde47 100644 --- a/src/Data/Digit/Char.hs +++ b/src/Data/Digit/Char.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Char +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Char( -- * Binary charBinaryNoZero diff --git a/src/Data/Digit/Class/D0.hs b/src/Data/Digit/Class/D0.hs index d12e645..237914e 100644 --- a/src/Data/Digit/Class/D0.hs +++ b/src/Data/Digit/Class/D0.hs @@ -1,6 +1,16 @@ {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE FlexibleInstances #-} +{-| +Module : Data.Digit.Class.D0 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D0( D0(..) , parse0 @@ -19,6 +29,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 0 class D0 d where d0 :: Prism' diff --git a/src/Data/Digit/Class/D1.hs b/src/Data/Digit/Class/D1.hs index b9ffea5..12ad6ea 100644 --- a/src/Data/Digit/Class/D1.hs +++ b/src/Data/Digit/Class/D1.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D1 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D1( D1(..) , parse1 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 1 class D1 d where d1 :: Prism' diff --git a/src/Data/Digit/Class/D2.hs b/src/Data/Digit/Class/D2.hs index 31e528e..2ce6081 100644 --- a/src/Data/Digit/Class/D2.hs +++ b/src/Data/Digit/Class/D2.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D2 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D2( D2(..) , parse2 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 2 class D2 d where d2 :: Prism' diff --git a/src/Data/Digit/Class/D3.hs b/src/Data/Digit/Class/D3.hs index 618b0c8..11461a6 100644 --- a/src/Data/Digit/Class/D3.hs +++ b/src/Data/Digit/Class/D3.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D3 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D3( D3(..) , parse3 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 3 class D3 d where d3 :: Prism' diff --git a/src/Data/Digit/Class/D4.hs b/src/Data/Digit/Class/D4.hs index 3cb1848..5f8aef7 100644 --- a/src/Data/Digit/Class/D4.hs +++ b/src/Data/Digit/Class/D4.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D4 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D4( D4(..) , parse4 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 4 class D4 d where d4 :: Prism' diff --git a/src/Data/Digit/Class/D5.hs b/src/Data/Digit/Class/D5.hs index cc76ee2..9b0d4f7 100644 --- a/src/Data/Digit/Class/D5.hs +++ b/src/Data/Digit/Class/D5.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D5 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D5( D5(..) , parse5 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 5 class D5 d where d5 :: Prism' diff --git a/src/Data/Digit/Class/D6.hs b/src/Data/Digit/Class/D6.hs index 4da386e..9c64071 100644 --- a/src/Data/Digit/Class/D6.hs +++ b/src/Data/Digit/Class/D6.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D6 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D6( D6(..) , parse6 @@ -19,6 +29,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 6 class D6 d where d6 :: Prism' diff --git a/src/Data/Digit/Class/D7.hs b/src/Data/Digit/Class/D7.hs index 00ec312..c48260b 100644 --- a/src/Data/Digit/Class/D7.hs +++ b/src/Data/Digit/Class/D7.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D7 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D7( D7(..) , parse7 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 7 class D7 d where d7 :: Prism' diff --git a/src/Data/Digit/Class/D8.hs b/src/Data/Digit/Class/D8.hs index 3b88aef..b4b8703 100644 --- a/src/Data/Digit/Class/D8.hs +++ b/src/Data/Digit/Class/D8.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D8 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D8( D8(..) , parse8 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 8 class D8 d where d8 :: Prism' diff --git a/src/Data/Digit/Class/D9.hs b/src/Data/Digit/Class/D9.hs index 7f86186..153661f 100644 --- a/src/Data/Digit/Class/D9.hs +++ b/src/Data/Digit/Class/D9.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.D9 +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.D9( D9(..) , parse9 @@ -18,6 +28,7 @@ import Text.Parser.Combinators(()) -- >>> import Text.Parsec(parse, ParseError, eof) -- >>> import Data.Void(Void) +-- | Classy prism for the digit 9 class D9 d where d9 :: Prism' diff --git a/src/Data/Digit/Class/LowerCase.hs b/src/Data/Digit/Class/LowerCase.hs index 6cd0ce0..7900306 100644 --- a/src/Data/Digit/Class/LowerCase.hs +++ b/src/Data/Digit/Class/LowerCase.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.LowerCase +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.LowerCase ( -- * Classes diff --git a/src/Data/Digit/Class/MixedCase.hs b/src/Data/Digit/Class/MixedCase.hs index 2b07562..0980619 100644 --- a/src/Data/Digit/Class/MixedCase.hs +++ b/src/Data/Digit/Class/MixedCase.hs @@ -4,6 +4,16 @@ {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE TypeFamilies #-} +{-| +Module : Data.Digit.Class.MixedCase +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.MixedCase ( -- * Types diff --git a/src/Data/Digit/Class/UpperCase.hs b/src/Data/Digit/Class/UpperCase.hs index fb95ddd..e80311e 100644 --- a/src/Data/Digit/Class/UpperCase.hs +++ b/src/Data/Digit/Class/UpperCase.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Class.UpperCase +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Class.UpperCase ( -- * Classes diff --git a/src/Data/Digit/Decimal.hs b/src/Data/Digit/Decimal.hs index 504e551..9d99cdd 100644 --- a/src/Data/Digit/Decimal.hs +++ b/src/Data/Digit/Decimal.hs @@ -2,6 +2,16 @@ {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE TemplateHaskell #-} +{-| +Module : Data.Digit.Decimal +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Decimal( DecDigit(..) , DecimalNoZero diff --git a/src/Data/Digit/Enum.hs b/src/Data/Digit/Enum.hs index aa0a9d0..be872f7 100644 --- a/src/Data/Digit/Enum.hs +++ b/src/Data/Digit/Enum.hs @@ -1,3 +1,13 @@ +{-| +Module : Data.Digit.Enum +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Enum ( -- * Binary enumBinaryNoZero diff --git a/src/Data/Digit/Hexadecimal/LowerCase.hs b/src/Data/Digit/Hexadecimal/LowerCase.hs index a6a1c3d..9dae5bd 100644 --- a/src/Data/Digit/Hexadecimal/LowerCase.hs +++ b/src/Data/Digit/Hexadecimal/LowerCase.hs @@ -2,6 +2,16 @@ {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE TemplateHaskell #-} +{-| +Module : Data.Digit.Hexadecimal.LowerCase +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Hexadecimal.LowerCase( HexDigit(..) , HexadecimalNoZero diff --git a/src/Data/Digit/Hexadecimal/MixedCase.hs b/src/Data/Digit/Hexadecimal/MixedCase.hs index b1731c3..1aaa970 100644 --- a/src/Data/Digit/Hexadecimal/MixedCase.hs +++ b/src/Data/Digit/Hexadecimal/MixedCase.hs @@ -2,6 +2,16 @@ {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE TemplateHaskell #-} +{-| +Module : Data.Digit.Hexadecimal.MixedCase +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Hexadecimal.MixedCase( HeXDigit(..) , HeXaDeCiMaLNoZero diff --git a/src/Data/Digit/Hexadecimal/UpperCase.hs b/src/Data/Digit/Hexadecimal/UpperCase.hs index 942d60f..b8bc750 100644 --- a/src/Data/Digit/Hexadecimal/UpperCase.hs +++ b/src/Data/Digit/Hexadecimal/UpperCase.hs @@ -2,6 +2,16 @@ {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE TemplateHaskell #-} +{-| +Module : Data.Digit.Hexadecimal.UpperCase +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Hexadecimal.UpperCase( HEXDigit(..) , HEXADECIMALNoZero diff --git a/src/Data/Digit/Integral.hs b/src/Data/Digit/Integral.hs index 1d32f0d..5850cea 100644 --- a/src/Data/Digit/Integral.hs +++ b/src/Data/Digit/Integral.hs @@ -1,5 +1,15 @@ {-# LANGUAGE NoImplicitPrelude #-} +{-| +Module : Data.Digit.Integral +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Integral( -- * Binary integralBinaryNoZero diff --git a/src/Data/Digit/Natural.hs b/src/Data/Digit/Natural.hs index 8d6bbe3..8385d47 100644 --- a/src/Data/Digit/Natural.hs +++ b/src/Data/Digit/Natural.hs @@ -1,3 +1,13 @@ +{-| +Module : Data.Digit.Natural +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Natural ( _NaturalDigits , naturalToDigits diff --git a/src/Data/Digit/Octal.hs b/src/Data/Digit/Octal.hs index c1bc8ab..d28ca28 100644 --- a/src/Data/Digit/Octal.hs +++ b/src/Data/Digit/Octal.hs @@ -2,6 +2,16 @@ {-# LANGUAGE ConstraintKinds #-} {-# LANGUAGE TemplateHaskell #-} +{-| +Module : Data.Digit.Octal +Copyright : (C) 2010-2016 NICTA Limited + (C) 2017-2018 CSIRO +License : BSD3 +Maintainer : Queensland Functional Programming Lab +Stability : experimental +Portability : non-portable +-} + module Data.Digit.Octal( OctDigit(..) , OctalNoZero