Fix Haddock errors.
authorThomas Schilling <nominolo@googlemail.com>
Sun, 20 Jul 2008 17:11:13 +0000 (17:11 +0000)
committerThomas Schilling <nominolo@googlemail.com>
Sun, 20 Jul 2008 17:11:13 +0000 (17:11 +0000)
compiler/coreSyn/CoreLint.lhs
compiler/coreSyn/CoreSubst.lhs
compiler/coreSyn/CoreUtils.lhs

index 8f5538c..5ee89cc 100644 (file)
@@ -626,7 +626,7 @@ data LintLocInfo
   | LambdaBodyOf Id    -- The lambda-binder
   | BodyOfLetRec [Id]  -- One of the binders
   | CaseAlt CoreAlt    -- Case alternative
   | LambdaBodyOf Id    -- The lambda-binder
   | BodyOfLetRec [Id]  -- One of the binders
   | CaseAlt CoreAlt    -- Case alternative
-  | CasePat CoreAlt    -- *Pattern* of the case alternative
+  | CasePat CoreAlt    -- The *pattern* of the case alternative
   | AnExpr CoreExpr    -- Some expression
   | ImportedUnfolding SrcLoc -- Some imported unfolding (ToDo: say which)
   | TopLevelBindings
   | AnExpr CoreExpr    -- Some expression
   | ImportedUnfolding SrcLoc -- Some imported unfolding (ToDo: say which)
   | TopLevelBindings
index e63b036..ac95987 100644 (file)
@@ -57,10 +57,10 @@ import Data.List
 
 \begin{code}
 data Subst 
 
 \begin{code}
 data Subst 
-  = Subst InScopeSet   -- Variables in in scope (both Ids and TyVars)
-                       -- *after* applying the substitution
-         IdSubstEnv    -- Substitution for Ids
-         TvSubstEnv    -- Substitution for TyVars
+  = Subst InScopeSet  -- Variables in in scope (both Ids and TyVars) /after/
+                      -- applying the substitution
+          IdSubstEnv  -- Substitution for Ids
+          TvSubstEnv  -- Substitution for TyVars
 
        -- INVARIANT 1: The (domain of the) in-scope set is a superset
        --              of the free vars of the range of the substitution
 
        -- INVARIANT 1: The (domain of the) in-scope set is a superset
        --              of the free vars of the range of the substitution
@@ -337,7 +337,7 @@ substIdBndr rec_subst subst@(Subst in_scope env tvs) old_id
 
     no_change = id1 == old_id
        -- See Note [Extending the Subst]
 
     no_change = id1 == old_id
        -- See Note [Extending the Subst]
-       -- *not* necessary to check mb_new_info and no_type_change
+       -- it's /not/ necessary to check mb_new_info and no_type_change
 \end{code}
 
 Now a variant that unconditionally allocates a new unique.
 \end{code}
 
 Now a variant that unconditionally allocates a new unique.
index e41623c..ec808d4 100644 (file)
@@ -997,8 +997,8 @@ arityType :: DynFlags -> CoreExpr -> ArityType
 
 arityType dflags (Note _ e) = arityType dflags e
 --     Not needed any more: etaExpand is cleverer
 
 arityType dflags (Note _ e) = arityType dflags e
 --     Not needed any more: etaExpand is cleverer
---  | ok_note n = arityType dflags e
---  | otherwise = ATop
+-- removed: | ok_note n = arityType dflags e
+-- removed: | otherwise = ATop
 
 arityType dflags (Cast e _) = arityType dflags e
 
 
 arityType dflags (Cast e _) = arityType dflags e
 
@@ -1118,7 +1118,6 @@ etaExpand n us expr ty
   | manifestArity expr >= n = expr             -- The no-op case
   | otherwise              
   = eta_expand n us expr ty
   | manifestArity expr >= n = expr             -- The no-op case
   | otherwise              
   = eta_expand n us expr ty
-  where
 
 -- manifestArity sees how many leading value lambdas there are
 manifestArity :: CoreExpr -> Arity
 
 -- manifestArity sees how many leading value lambdas there are
 manifestArity :: CoreExpr -> Arity
@@ -1439,7 +1438,7 @@ hashExpr :: CoreExpr -> Int
 hashExpr e = fromIntegral (hash_expr (1,emptyVarEnv) e .&. 0x7fffffff)
              -- UniqFM doesn't like negative Ints
 
 hashExpr e = fromIntegral (hash_expr (1,emptyVarEnv) e .&. 0x7fffffff)
              -- UniqFM doesn't like negative Ints
 
-type HashEnv = (Int, VarEnv Int)       -- Hash code for bound variables
+type HashEnv = (Int, VarEnv Int)  -- ^ Hash code for bound variables
 
 hash_expr :: HashEnv -> CoreExpr -> Word32
 -- Word32, because we're expecting overflows here, and overflowing
 
 hash_expr :: HashEnv -> CoreExpr -> Word32
 -- Word32, because we're expecting overflows here, and overflowing