[project @ 2003-07-31 09:28:47 by ralf]

Cosmetic changes.
Documentation of Data.Generics at
http://www.cs.vu.nl/boilerplate/
is now also again well in line with the major
revision of Data.Generics from last week.

diff --git a/Data/Generics.hs b/Data/Generics.hs
index 59c0bdd..16c5027 100644 (file)
--- a/Data/Generics.hs
+++ b/Data/Generics.hs
@@ -9,22 +9,21 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- 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 ( 
 
-  -- * 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.
-  --
+  -- * All Data.Generics modules
   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
+  module Data.Generics.Reify   -- experimental reification theme
 
 #ifndef __HADDOCK__
        ,

diff --git a/Data/Generics/Aliases.hs b/Data/Generics/Aliases.hs
index b2213e7..b1bcd96 100644 (file)
--- a/Data/Generics/Aliases.hs
+++ b/Data/Generics/Aliases.hs
@@ -9,7 +9,9 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- See <http://www.cs.vu.nl/boilerplate/>. The present module provides
+-- a number of declarations for typical generic function types,
+-- corresponding type case, and others.
 --
 -----------------------------------------------------------------------------
 

diff --git a/Data/Generics/Basics.hs b/Data/Generics/Basics.hs
index 4d9bd35..6ce3aac 100644 (file)
--- a/Data/Generics/Basics.hs
+++ b/Data/Generics/Basics.hs
@@ -9,7 +9,8 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- See <http://www.cs.vu.nl/boilerplate/>. The present module provides
+-- the Data class with its primitives for generic programming.
 --
 -----------------------------------------------------------------------------
 

diff --git a/Data/Generics/Reify.hs b/Data/Generics/Reify.hs
index 7ec23c4..b5a9998 100644 (file)
--- a/Data/Generics/Reify.hs
+++ b/Data/Generics/Reify.hs
@@ -9,7 +9,8 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- See <http://www.cs.vu.nl/boilerplate/>. The present module provides
+-- some preliminary support to compute on types.
 --
 -----------------------------------------------------------------------------
 
@@ -26,6 +27,7 @@ module Data.Generics.Reify (
        resType,                -- :: (a -> b) -> TypeVal b
        paraType,               -- :: t a -> TypeVal a
        TypeFun,                -- functions on types
+       GTypeFun,               -- polymorphic functions on types
 
        -- * Generic operations to reify terms
        glength,
@@ -122,7 +124,7 @@ type TypeFun a r = TypeVal a -> r
 -- Generic type functions,
 -- i.e., functions mapping types to values
 --
-type GTypeFun r  = forall a. Typeable a => TypeFun a r
+type GTypeFun r  = forall a. Data a => TypeFun a r
 
 
 

diff --git a/Data/Generics/Schemes.hs b/Data/Generics/Schemes.hs
index c9aa40f..f88445c 100644 (file)
--- a/Data/Generics/Schemes.hs
+++ b/Data/Generics/Schemes.hs
@@ -9,13 +9,13 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- See <http://www.cs.vu.nl/boilerplate/>. The present module provides
+-- frequently used generic traversal schemes.
 --
 -----------------------------------------------------------------------------
 
 module Data.Generics.Schemes ( 
 
-       -- * Frequently used generic traversal schemes
         everywhere,
         everywhere',
         everywhereBut,

diff --git a/Data/Generics/Text.hs b/Data/Generics/Text.hs
index c705e07..3cb10ee 100644 (file)
--- a/Data/Generics/Text.hs
+++ b/Data/Generics/Text.hs
@@ -9,13 +9,13 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- See <http://www.cs.vu.nl/boilerplate/>. The present module provides
+-- generic operations for text serialisation of terms.
 --
 -----------------------------------------------------------------------------
 
 module Data.Generics.Text ( 
 
-       -- * Generic operations for string representations of terms
        gshow,
        gread
 

diff --git a/Data/Generics/Twins.hs b/Data/Generics/Twins.hs
index 6b3256a..2ab33ae 100644 (file)
--- a/Data/Generics/Twins.hs
+++ b/Data/Generics/Twins.hs
@@ -9,7 +9,9 @@
 -- Portability :  non-portable
 --
 -- \"Scrap your boilerplate\" --- Generic programming in Haskell 
--- See <http://www.cs.vu.nl/boilerplate/>.
+-- See <http://www.cs.vu.nl/boilerplate/>. The present module 
+-- provides support for multi-parameter traversal, which is also 
+-- demonstrated with generic operations like equality.
 --
 -----------------------------------------------------------------------------