aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorDavid Waern <unknown>2007-08-29 23:48:03 +0000
committerDavid Waern <unknown>2007-08-29 23:48:03 +0000
commitc3e5faac8e9b81bab5654ac8de942cf5d6f81cf5 (patch)
tree1065e08c20a3fdb8371a2b88d6fae889c2fe4271 /src
parent2ad606aaea58bce57ebb1681831514caf6ff56a3 (diff)
Some comment cleanup
Diffstat (limited to 'src')
-rw-r--r--src/Haddock/Interface.hs11
-rw-r--r--src/Haddock/Types.hs8
2 files changed, 9 insertions, 10 deletions
diff --git a/src/Haddock/Interface.hs b/src/Haddock/Interface.hs
index 41a73480..4d931f21 100644
--- a/src/Haddock/Interface.hs
+++ b/src/Haddock/Interface.hs
@@ -1,13 +1,12 @@
--------------------------------------------------------------------------------
--- Haddock.Interface
--
+-- Haddock - A Haskell Documentation Tool
+--
+-- (c) Simon Marlow 2003
+--
+
-- Here we build the actual module interfaces. By interface we mean the
-- information that is used to render a Haddock page for a module. Parts of
-- this information is also stored in the interface files.
---
--- The Interface structure holds the interface data as well as
--- intermediate information needed during its creation.
--------------------------------------------------------------------------------
module Haddock.Interface (
diff --git a/src/Haddock/Types.hs b/src/Haddock/Types.hs
index 8b2cfa34..d3284a5c 100644
--- a/src/Haddock/Types.hs
+++ b/src/Haddock/Types.hs
@@ -88,7 +88,8 @@ instance Outputable DocName where
ppr (NoLink n) = ppr n
--- | Information about a home package module that we get from GHC's typechecker
+-- | This structure holds the module information we get from GHC's
+-- type checking phase
data GhcModule = GhcModule {
ghcModule :: Module,
ghcFilename :: FilePath,
@@ -105,9 +106,8 @@ data GhcModule = GhcModule {
-- | This is the data used to render a Haddock page for a module - it is the
-- "interface" of the module. The core of Haddock lies in creating this
--- structure (see Haddock.Interface).
---
--- The structure also holds intermediate data needed during its creation.
+-- structure (see Haddock.Interface). The structure also holds intermediate
+-- data needed during its creation.
data Interface = Interface {
-- | A value to identify the module