From: Thomas Schilling <nominolo@googlemail.com>
Date: Wed, 26 Nov 2008 13:43:44 +0000 (+0000)
Subject: Documentation only: Add module description for HscMain.
X-Git-Tag: 2009-03-13~391
X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=fdd5b2fbeb2c128cb9e0d9f2e29d8ececa46f97b;p=ghc-hetmet.git

Documentation only: Add module description for HscMain.
---

diff --git a/compiler/main/HscMain.lhs b/compiler/main/HscMain.lhs
index fee24c6..6aeaea2 100644
--- a/compiler/main/HscMain.lhs
+++ b/compiler/main/HscMain.lhs
@@ -1,10 +1,13 @@
 %
 % (c) The GRASP/AQUA Project, Glasgow University, 1993-2000
 %
-
-\section[GHC_Main]{Main driver for Glasgow Haskell compiler}
-
 \begin{code}
+-- | Main driver for the compiling plain Haskell source code.
+--
+-- This module implements compilation of a Haskell-only source file.  It is
+-- /not/ concerned with preprocessing of source files; this is handled in
+-- "DriverPipeline".
+--
 module HscMain
     ( newHscEnv, hscCmmFile
     , hscParseIdentifier