[project @ 2003-07-28 15:03:05 by panne]

[haskell-directory.git] / Data / Generics.hs

diff --git a/Data/Generics.hs b/Data/Generics.hs
index 82a08c8..59c0bdd 100644 (file)
--- a/Data/Generics.hs
+++ b/Data/Generics.hs
@@ -1,25 +1,55 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Data.Generics
--- Copyright   :  (c) The University of Glasgow 2001
--- License     :  BSD-style (see the file libraries/core/LICENSE)
+-- Copyright   :  (c) The University of Glasgow, CWI 2001--2003
+-- License     :  BSD-style (see the file libraries/base/LICENSE)
 -- 
 -- Maintainer  :  libraries@haskell.org
 -- Stability   :  experimental
 -- Portability :  non-portable
 --
--- Data types for generic definitions.
+-- \"Scrap your boilerplate\" --- Generic programming in Haskell 
+-- See <http://www.cs.vu.nl/boilerplate/>.
 --
 -----------------------------------------------------------------------------
 
 module Data.Generics ( 
-#ifdef __GLASGOW_HASKELL__
-       module GHC.Base
+
+  -- * To scrap your boilerplate it is sufficient to import this module.
+  --   This module does nothing more than import all themes of the
+  --   Data.Generics library.
+  --
+  module Data.Generics.Basics, -- primitives
+  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
+  module Data.Generics.Reify   -- experimental reification stuff
+
+#ifndef __HADDOCK__
+       ,
+       -- Data types for the sum-of-products type encoding;
+        -- included for backwards compatibility; maybe obsolete.
+       (:*:)(..), (:+:)(..), Unit(..)
 #endif
+
  ) where
 
-import Prelude
+------------------------------------------------------------------------------
+
+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.Aliases
+import Data.Generics.Schemes
+import Data.Generics.Text
+import Data.Generics.Twins
+import Data.Generics.Reify