on master help sign in
Tweak haddocks
f7f5d1eHerbert Valerio Riedel
uuid-types/Data/UUID/Types.hs+4−6
@@ -5,15 +5,13 @@ Copyright : (c) 2017-2018 Herbert Valerio Riedel
5
5
6License : BSD-style
6License : BSD-style
7
7
8−Maintainer : aslatter@gmail.com
8+Maintainer : hvr@gnu.org
9−Stability : experimental
10Portability : portable
9Portability : portable
11
10
12−
13This library is useful for comparing, parsing and
11This library is useful for comparing, parsing and
14printing Universally Unique Identifiers.
12printing Universally Unique Identifiers.
15See <http://en.wikipedia.org/wiki/UUID> for the general idea.
13See <http://en.wikipedia.org/wiki/UUID> for the general idea.
16−See <http://tools.ietf.org/html/rfc4122> for the specification.
14+See <http://tools.ietf.org/html/rfc4122 RFC 4122> for the specification.
17
15
18-}
16-}
19module Data.UUID.Types(UUID
17module Data.UUID.Types(UUID
@@ -35,8 +33,8 @@ module Data.UUID.Types(UUID
35 ,nil
33 ,nil
36 ) where
34 ) where
37
35
38−import Prelude () -- we need to hide Prelude.null
39−import Data.UUID.Types.Internal
36+import Data.UUID.Types.Internal
37+import Prelude ()
40
38
41-- Everything is really implemented in Data.UUID.Types.Internal, but I
39-- Everything is really implemented in Data.UUID.Types.Internal, but I
42-- don't want to export the constructors out of the package.
40-- don't want to export the constructors out of the package.
uuid-types/Data/UUID/Types/Internal.hs+6−6
@@ -6,13 +6,13 @@
6
6
7-- |
7-- |
8-- Module : Data.UUID.Types.Internal
8-- Module : Data.UUID.Types.Internal
9+-- Copyright : (c) 2017-2018 Herbert Valerio Riedel
9−-- Copyright : (c) 2008-2009, 2012 Antoine Latter
10+-- (c) 2008-2009, 2012 Antoine Latter
10-- (c) 2009 Mark Lentczner
11-- (c) 2009 Mark Lentczner
11--
12--
12-- License : BSD-style
13-- License : BSD-style
13--
14--
14−-- Maintainer : aslatter@gmail.com
15+-- Maintainer : hvr@gnu.org
15−-- Stability : experimental
16-- Portability : portable
16-- Portability : portable
17
17
18module Data.UUID.Types.Internal
18module Data.UUID.Types.Internal
@@ -77,8 +77,8 @@ import System.Random
77
77
78
78
79-- |The UUID type. A 'Random' instance is provided which produces
79-- |The UUID type. A 'Random' instance is provided which produces
80−-- insecure version 4 UUIDs as specified in RFC 4122. The 'Storable' and
80+-- insecure version 4 UUIDs as specified in <http://tools.ietf.org/html/rfc4122 RFC 4122>. The 'Storable' and
81−-- 'Binary' instances are compatible with RFC 4122, storing the fields in
81+-- 'Binary' instances are compatible with <http://tools.ietf.org/html/rfc4122 RFC 4122>, storing the fields in
82-- network order as 16 bytes.
82-- network order as 16 bytes.
83data UUID = UUID {-# UNPACK #-} !Word64 {-# UNPACK #-} !Word64
83data UUID = UUID {-# UNPACK #-} !Word64 {-# UNPACK #-} !Word64
84 deriving (Eq, Ord, Typeable)
84 deriving (Eq, Ord, Typeable)
@@ -273,7 +273,7 @@ null = (== nil)
273 -- null (UUID 0 0 0 0) = True
273 -- null (UUID 0 0 0 0) = True
274 -- null _ = False
274 -- null _ = False
275
275
276−-- |The nil UUID, as defined in RFC 4122.
276+-- |The nil UUID, as defined in <http://tools.ietf.org/html/rfc4122 RFC 4122>.
277-- It is a UUID of all zeros. @'null' u@ iff @'u' == 'nil'@.
277-- It is a UUID of all zeros. @'null' u@ iff @'u' == 'nil'@.
278nil :: UUID
278nil :: UUID
279nil = UUID 0 0
279nil = UUID 0 0