Cleanup module headers

9 files changed, 85 insertions, 16 deletions

diff --git a/CabalHelper/Compiletime/Compile.hs b/CabalHelper/Compiletime/Compile.hs
index 6ea2676..c27ab63 100644
--- a/CabalHelper/Compiletime/Compile.hs
+++ b/CabalHelper/Compiletime/Compile.hs
@@ -1,5 +1,4 @@
--- cabal-helper: Simple interface to Cabal's configuration state
--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>
+-- Copyright (C) 2015,2017  Daniel Gröber <dxld ÄT darkboxed DOT org>
 --
 -- This program is free software: you can redistribute it and/or modify
 -- it under the terms of the GNU Affero General Public License as published by
@@ -14,6 +13,13 @@
 -- You should have received a copy of the GNU Affero General Public License
 -- along with this program.  If not, see <http://www.gnu.org/licenses/>.
 {-# LANGUAGE RecordWildCards, FlexibleContexts #-}
+
+{-|
+Module      : CabalHelper.Compiletime.Compile
+Description : Runtime compilation machinery
+License     : AGPL-3
+-}
+
 module CabalHelper.Compiletime.Compile where
 
 import Control.Applicative
diff --git a/CabalHelper/Compiletime/Data.hs b/CabalHelper/Compiletime/Data.hs
index 346c2a5..2842cfc 100644
--- a/CabalHelper/Compiletime/Data.hs
+++ b/CabalHelper/Compiletime/Data.hs
@@ -1,5 +1,4 @@
--- cabal-helper: Simple interface to Cabal's configuration state
--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>
+-- Copyright (C) 2015,2017  Daniel Gröber <dxld ÄT darkboxed DOT org>
 --
 -- This program is free software: you can redistribute it and/or modify
 -- it under the terms of the GNU Affero General Public License as published by
@@ -16,6 +15,13 @@
 
 {-# LANGUAGE TemplateHaskell, ScopedTypeVariables #-}
 {-# OPTIONS_GHC -fforce-recomp #-}
+
+{-|
+Module      : CabalHelper.Compiletime.Data
+Description : Embeds source code for runtime component using TH
+License     : AGPL-3
+-}
+
 module CabalHelper.Compiletime.Data where
 
 import Control.Monad
diff --git a/CabalHelper/Compiletime/GuessGhc.hs b/CabalHelper/Compiletime/GuessGhc.hs
index e1cf577..f4b33d5 100644
--- a/CabalHelper/Compiletime/GuessGhc.hs
+++ b/CabalHelper/Compiletime/GuessGhc.hs
@@ -1,11 +1,3 @@
-module CabalHelper.Compiletime.GuessGhc (guessToolFromGhcPath) where
-
-import Data.Maybe
-import Data.Char
-import Distribution.Simple.BuildPaths
-import System.Directory
-import System.FilePath
-
 -- Copyright (c) 2003-2014, Isaac Jones, Simon Marlow, Martin Sjögren,
 --                          Bjorn Bringert, Krasimir Angelov,
 --                          Malcolm Wallace, Ross Patterson, Ian Lynagh,
@@ -41,6 +33,20 @@ import System.FilePath
 -- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 -- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+{-|
+Module      : CabalHelper.Compiletime.GuessGhc
+Description : Logic for finding @ghc-pkg@ based on path to @ghc@
+License     : BSD3
+-}
+
+module CabalHelper.Compiletime.GuessGhc (guessToolFromGhcPath) where
+
+import Data.Maybe
+import Data.Char
+import Distribution.Simple.BuildPaths
+import System.Directory
+import System.FilePath
+
 guessToolFromGhcPath :: FilePath -- ^ Tool name
                      -> FilePath -- ^ GHC exe path
                      -> IO (Maybe FilePath)
diff --git a/CabalHelper/Compiletime/Log.hs b/CabalHelper/Compiletime/Log.hs
index eb7ecaa..a75f8b7 100644
--- a/CabalHelper/Compiletime/Log.hs
+++ b/CabalHelper/Compiletime/Log.hs
@@ -1,5 +1,26 @@
+-- Copyright (C) 2017  Daniel Gröber <dxld ÄT darkboxed DOT org>
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as published by
+-- the Free Software Foundation, either version 3 of the License, or
+-- (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 {-# LANGUAGE ScopedTypeVariables #-}
 
+{-|
+Module      : CabalHelper.Compiletime.Log
+Description : Basic logging facilities
+License     : AGPL-3
+-}
+
 module CabalHelper.Compiletime.Log where
 
 import Control.Monad
diff --git a/CabalHelper/Compiletime/Types.hs b/CabalHelper/Compiletime/Types.hs
index da6eb4d..bfe9b7c 100644
--- a/CabalHelper/Compiletime/Types.hs
+++ b/CabalHelper/Compiletime/Types.hs
@@ -1,4 +1,3 @@
--- cabal-helper: Simple interface to Cabal's configuration state
 -- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>
 --
 -- This program is free software: you can redistribute it and/or modify
@@ -15,6 +14,13 @@
 -- along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 {-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures #-}
+
+{-|
+Module      : CabalHelper.Compiletime.Types
+Description : Types used throughout
+License     : AGPL-3
+-}
+
 module CabalHelper.Compiletime.Types where
 
 import Data.Version
diff --git a/CabalHelper/Runtime/Main.hs b/CabalHelper/Runtime/Main.hs
index 8895069..86bf169 100644
--- a/CabalHelper/Runtime/Main.hs
+++ b/CabalHelper/Runtime/Main.hs
@@ -1,4 +1,3 @@
--- cabal-helper: Simple interface to Cabal's configuration state
 -- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>
 --
 -- This program is free software: you can redistribute it and/or modify
diff --git a/CabalHelper/Shared/Common.hs b/CabalHelper/Shared/Common.hs
index 12c7d93..239fe3c 100644
--- a/CabalHelper/Shared/Common.hs
+++ b/CabalHelper/Shared/Common.hs
@@ -1,4 +1,3 @@
--- cabal-helper: Simple interface to Cabal's configuration state
 -- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>
 --
 -- This program is free software: you can redistribute it and/or modify
@@ -14,6 +13,12 @@
 -- You should have received a copy of the GNU Affero General Public License
 -- along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+{-|
+Module      : CabalHelper.Shared.Common
+Description : Shared utility functions
+License     : AGPL-3
+-}
+
 {-# LANGUAGE DeriveDataTypeable, OverloadedStrings #-}
 module CabalHelper.Shared.Common where
 
diff --git a/CabalHelper/Shared/InterfaceTypes.hs b/CabalHelper/Shared/InterfaceTypes.hs
index 88858d0..5f4972f 100644
--- a/CabalHelper/Shared/InterfaceTypes.hs
+++ b/CabalHelper/Shared/InterfaceTypes.hs
@@ -1,4 +1,3 @@
--- cabal-helper: Simple interface to Cabal's configuration state
 -- Copyright (C) 2015,2017  Daniel Gröber <dxld ÄT darkboxed DOT org>
 --
 -- This program is free software: you can redistribute it and/or modify
diff --git a/CabalHelper/Shared/Sandbox.hs b/CabalHelper/Shared/Sandbox.hs
index 3523edc..4dd9705 100644
--- a/CabalHelper/Shared/Sandbox.hs
+++ b/CabalHelper/Shared/Sandbox.hs
@@ -1,3 +1,24 @@
+-- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>
+--
+-- This program is free software: you can redistribute it and/or modify
+-- it under the terms of the GNU Affero General Public License as published by
+-- the Free Software Foundation, either version 3 of the License, or
+-- (at your option) any later version.
+--
+-- This program is distributed in the hope that it will be useful,
+-- but WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+-- GNU Affero General Public License for more details.
+--
+-- You should have received a copy of the GNU Affero General Public License
+-- along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+{-|
+Module      : CabalHelper.Shared.Sandbox
+Description : Extracting information from @cabal.sandbox.config@ files
+License     : AGPL-3
+-}
+
 module CabalHelper.Shared.Sandbox where
 
 import Control.Applicative