on master help sign in
documentation improvements
commit36bcbf8acbdc1eddfea490479d1b0547d4ac7a63 authorAntoine Latter <aslatter@gmail.com> dateThu 14 Jun 2012, 02:24 (14 years ago) parentf1898a1
3 files changed+50−38
Data/UUID.hs+25−18 Data/UUID/V3.hs+24−19 Data/UUID/V4.hs+1−1
Data/UUID.hs+25−18
@@ -1,21 +1,28 @@
1−-- |
2−-- Module : Data.UUID
3−-- Copyright : (c) 2008 Antoine Latter
4−--
5−-- License : BSD-style
6−--
7−-- Maintainer : aslatter@gmail.com
8−-- Stability : experimental
9−-- Portability : portable
10−--
11−--
12−-- This library is useful for comparing, parsing and
13−-- printing Universally Unique Identifiers.
14−-- See <http://en.wikipedia.org/wiki/UUID> for the general idea.
15−-- See <http://tools.ietf.org/html/rfc4122> for the specification.
16−--
17−-- For generating UUIDs, check out 'Data.UUID.V1', 'Data.UUID.V5' and
18−-- 'System.Random'.
1+{- |
2+Module : Data.UUID
3+Copyright : (c) 2008,2012 Antoine Latter
4+
5+License : BSD-style
6+
7+Maintainer : aslatter@gmail.com
8+Stability : experimental
9+Portability : portable
10+
11+
12+This library is useful for comparing, parsing and
13+printing Universally Unique Identifiers.
14+See <http://en.wikipedia.org/wiki/UUID> for the general idea.
15+See <http://tools.ietf.org/html/rfc4122> for the specification.
16+
17+* Random UUIDs may be generated using 'Data.UUID.V4.nextRandom' or
18+your favorite instance of 'System.Random.Random'.
19+
20+* We have an implementation of generating a UUID from the hardware
21+MAC address and current system time in "Data.UUID.V1".
22+
23+* For name-based generation of UUIDs using SHA-1 hashing see
24+"Data.UUID.V5".
25+-}
1926
2027module Data.UUID(UUID
2128 ,toString
Data/UUID/V3.hs+24−19
@@ -1,23 +1,28 @@
1−-- |
2−-- Module : Data.UUID.V3
3−-- Copyright : (c) 2010 Antoine Latter
4−--
5−-- License : BSD-style
6−--
7−-- Maintainer : aslatter@gmail.com
8−-- Stability : experimental
9−-- Portability : portable
10−--
11−--
12−-- This module implements Version 3 UUIDs as specified
13−-- in RFC 4122.
14−--
15−-- These UUIDs identify an object within a namespace,
16−-- and are deterministic.
17−--
18−-- The namespace is identified by a UUID. Several sample
19−-- namespaces are enclosed.
1+{- |
2+Module : Data.UUID.V3
3+Copyright : (c) 2010,2012 Antoine Latter
4+
5+License : BSD-style
6+
7+Maintainer : aslatter@gmail.com
8+Stability : experimental
9+Portability : portable
10+
11+NOTE: This module uses MD5 hashing. Unless you know
12+you need to use this module, you should probably be
13+using "Data.UUID.V5", which offers the same sort of
14+functionality as this module except implemented with
15+SHA-1 hashing.
16+
17+This module implements Version 3 UUIDs as specified
18+in RFC 4122.
19+
20+These UUIDs identify an object within a namespace,
21+and are deterministic.
2022
23+The namespace is identified by a UUID. Several sample
24+namespaces are enclosed.
25+-}
2126module Data.UUID.V3
2227 (generateNamed
2328 ,Shared.namespaceDNS
Data/UUID/V4.hs+1−1
@@ -15,7 +15,7 @@
1515 We use the System.Random 'R.StdGen' as our random source.
1616
1717 All of the logic is encapsulated in the 'R.Random' instance
18− for the UUID type, so you are free to use the random generator
18+ for the UUID type, so you are also free to use the random generator
1919 of your choice.
2020-}
2121module Data.UUID.V4 (nextRandom) where