[project @ 2005-03-15 13:38:27 by simonmar]

[ghc-base.git] / Data / Generics.hs

diff --git a/Data/Generics.hs b/Data/Generics.hs
index cc32172..525efdc 100644 (file)
--- a/Data/Generics.hs
+++ b/Data/Generics.hs
@@ -1,33 +1,34 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Data.Generics
--- Copyright   :  (c) The University of Glasgow, CWI 2001--2003
+-- Copyright   :  (c) The University of Glasgow, CWI 2001--2004
 -- License     :  BSD-style (see the file libraries/base/LICENSE)
 -- 
 -- Maintainer  :  libraries@haskell.org
 -- Stability   :  experimental
 -- Portability :  non-portable
 --
--- "Scrap your boilerplate" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- \"Scrap your boilerplate\" --- Generic programming in Haskell 
+-- See <http://www.cs.vu.nl/boilerplate/>. To scrap your boilerplate it
+-- is sufficient to import the present module, which simply re-exports all
+-- themes of the Data.Generics library.
 --
 -----------------------------------------------------------------------------
 
 module Data.Generics ( 
 
-       -- * Re-export all relevant modules
-       module Data.Generics.Basics,
-       module Data.Generics.Aliases,
-       module Data.Generics.Schemes,
-       module Data.Generics.Twins,
-       module Data.Generics.Strings,
-       module Data.Generics.Counts,
-       module Data.Generics.Types
+  -- * All Data.Generics modules
+  module Data.Generics.Basics,   -- primitives
+  module Data.Generics.Instances, -- instances of Data class
+  module Data.Generics.Aliases,          -- aliases for type case, generic types
+  module Data.Generics.Schemes,          -- traversal schemes (everywhere etc.)
+  module Data.Generics.Text,     -- generic read and show
+  module Data.Generics.Twins,            -- twin traversal, e.g., generic eq
 
 #ifndef __HADDOCK__
        ,
        -- Data types for the sum-of-products type encoding;
-        -- included for backwards compatibility; maybe obsolete
+        -- included for backwards compatibility; maybe obsolete.
        (:*:)(..), (:+:)(..), Unit(..)
 #endif
 
@@ -39,14 +40,15 @@ import Prelude      -- So that 'make depend' works
 
 #ifdef __GLASGOW_HASKELL__
 #ifndef __HADDOCK__
+       -- Data types for the sum-of-products type encoding;
+        -- included for backwards compatibility; maybe obsolete.
 import GHC.Base ( (:*:)(..), (:+:)(..), Unit(..) )
 #endif
 #endif
 
 import Data.Generics.Basics
+import Data.Generics.Instances
 import Data.Generics.Aliases
 import Data.Generics.Schemes
+import Data.Generics.Text
 import Data.Generics.Twins
-import Data.Generics.Strings
-import Data.Generics.Counts
-import Data.Generics.Types