From 448d5b29a18ee9ef88a43879bf850ff16f327cb8 Mon Sep 17 00:00:00 2001 From: David Waern Date: Wed, 24 Jun 2009 22:23:23 +0000 Subject: Add Haddock module headers Add a proper Haddock module header to each module, with a more finegrained copyright. If you feel mis-accreditted, please correct any copyright notice! The maintainer field is set to haddock@projects.haskell.org. Next step is to add a brief description to each module. --- src/Haddock/Backends/DevHelp.hs | 14 ++++++++++---- src/Haddock/Backends/HH.hs | 13 +++++++++---- src/Haddock/Backends/HH2.hs | 14 +++++++++----- src/Haddock/Backends/HaddockDB.hs | 13 +++++++++---- src/Haddock/Backends/Hoogle.hs | 13 +++++++++---- src/Haddock/Backends/Html.hs | 15 ++++++++++----- src/Haddock/GhcUtils.hs | 20 ++++++++++++-------- src/Haddock/Interface.hs | 21 +++++++++++++-------- src/Haddock/Interface/AttachInstances.hs | 18 ++++++++++-------- src/Haddock/Interface/Create.hs | 15 ++++++++++----- src/Haddock/Interface/Rename.hs | 15 ++++++++++----- src/Haddock/InterfaceFile.hs | 15 ++++++++++----- src/Haddock/ModuleTree.hs | 14 ++++++++++---- src/Haddock/Options.hs | 14 +++++++++++--- src/Haddock/Types.hs | 17 ++++++++++++----- src/Haddock/Utils.hs | 16 +++++++++++----- src/Haddock/Version.hs | 13 +++++++++---- src/Main.hs | 18 ++++++++++++------ 18 files changed, 186 insertions(+), 92 deletions(-) diff --git a/src/Haddock/Backends/DevHelp.hs b/src/Haddock/Backends/DevHelp.hs index b7e2d72f..0bac7462 100644 --- a/src/Haddock/Backends/DevHelp.hs +++ b/src/Haddock/Backends/DevHelp.hs @@ -1,8 +1,14 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Backends.DevHelp +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Backends.DevHelp (ppDevHelpFile) where diff --git a/src/Haddock/Backends/HH.hs b/src/Haddock/Backends/HH.hs index fcb9c663..8446de74 100644 --- a/src/Haddock/Backends/HH.hs +++ b/src/Haddock/Backends/HH.hs @@ -1,8 +1,13 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Backends.HH +-- Copyright : (c) Simon Marlow 2003 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Backends.HH (ppHHContents, ppHHIndex, ppHHProject) where diff --git a/src/Haddock/Backends/HH2.hs b/src/Haddock/Backends/HH2.hs index 7015236f..e9cf203c 100644 --- a/src/Haddock/Backends/HH2.hs +++ b/src/Haddock/Backends/HH2.hs @@ -1,9 +1,13 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Backends.HH2 +-- Copyright : (c) Simon Marlow 2003 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- - +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Backends.HH2 (ppHH2Contents, ppHH2Index, ppHH2Files, ppHH2Collection) where diff --git a/src/Haddock/Backends/HaddockDB.hs b/src/Haddock/Backends/HaddockDB.hs index 9be79c27..1ff09975 100644 --- a/src/Haddock/Backends/HaddockDB.hs +++ b/src/Haddock/Backends/HaddockDB.hs @@ -1,8 +1,13 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Backends.HaddockDB +-- Copyright : (c) Simon Marlow 2003 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Backends.HaddockDB (ppDocBook) where diff --git a/src/Haddock/Backends/Hoogle.hs b/src/Haddock/Backends/Hoogle.hs index 089e58de..542947d7 100644 --- a/src/Haddock/Backends/Hoogle.hs +++ b/src/Haddock/Backends/Hoogle.hs @@ -1,11 +1,16 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Backends.Hoogle +-- Copyright : (c) Neil Mitchell 2006-2008 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable -- --- (c) Simon Marlow 2003 --- --- This file, (c) Neil Mitchell 2006-2008 -- Write out Hoogle compatible documentation -- http://www.haskell.org/hoogle/ +----------------------------------------------------------------------------- module Haddock.Backends.Hoogle ( ppHoogle diff --git a/src/Haddock/Backends/Html.hs b/src/Haddock/Backends/Html.hs index aa623cb6..e48396b2 100644 --- a/src/Haddock/Backends/Html.hs +++ b/src/Haddock/Backends/Html.hs @@ -1,9 +1,14 @@ - --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Backends.Html +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- - +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Backends.Html ( ppHtml, copyHtmlBits, diff --git a/src/Haddock/GhcUtils.hs b/src/Haddock/GhcUtils.hs index af091a7a..4107a1e5 100644 --- a/src/Haddock/GhcUtils.hs +++ b/src/Haddock/GhcUtils.hs @@ -1,14 +1,18 @@ --- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- - - {-# LANGUAGE FlexibleInstances #-} {-# OPTIONS_GHC -fno-warn-orphans #-} {-# OPTIONS_HADDOCK hide #-} - +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.GhcUtils +-- Copyright : (c) David Waern 2006-2009 +-- License : BSD-like +-- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +-- +-- Utils for dealing with types from the GHC API +----------------------------------------------------------------------------- module Haddock.GhcUtils where diff --git a/src/Haddock/Interface.hs b/src/Haddock/Interface.hs index b5f73ddb..9ec622b7 100644 --- a/src/Haddock/Interface.hs +++ b/src/Haddock/Interface.hs @@ -1,13 +1,18 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Interface +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable -- --- (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. - +-- 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 .haddock files. +----------------------------------------------------------------------------- module Haddock.Interface ( createInterfaces diff --git a/src/Haddock/Interface/AttachInstances.hs b/src/Haddock/Interface/AttachInstances.hs index 9ec3a3f2..eb0d719e 100644 --- a/src/Haddock/Interface/AttachInstances.hs +++ b/src/Haddock/Interface/AttachInstances.hs @@ -1,12 +1,14 @@ --- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- - - {-# LANGUAGE MagicHash #-} - +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Interface.AttachInstances +-- Copyright : (c) David Waern 2006-2009 +-- License : BSD-like +-- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Interface.AttachInstances (attachInstances) where diff --git a/src/Haddock/Interface/Create.hs b/src/Haddock/Interface/Create.hs index 0b271900..e21c27fe 100644 --- a/src/Haddock/Interface/Create.hs +++ b/src/Haddock/Interface/Create.hs @@ -1,9 +1,14 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Interface.Create +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- - +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Interface.Create (createInterface) where diff --git a/src/Haddock/Interface/Rename.hs b/src/Haddock/Interface/Rename.hs index 733a372f..f07dc7ef 100644 --- a/src/Haddock/Interface/Rename.hs +++ b/src/Haddock/Interface/Rename.hs @@ -1,9 +1,14 @@ +---------------------------------------------------------------------------- +-- | +-- Module : Haddock.Interface.Rename +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- - +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Interface.Rename (renameInterface) where diff --git a/src/Haddock/InterfaceFile.hs b/src/Haddock/InterfaceFile.hs index f4c74cb9..78d88816 100644 --- a/src/Haddock/InterfaceFile.hs +++ b/src/Haddock/InterfaceFile.hs @@ -1,11 +1,16 @@ {-# OPTIONS_GHC -fno-warn-orphans #-} - --- --- Haddock - A Haskell Documentation Tool +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.InterfaceFile +-- Copyright : (c) David Waern 2006-2009 +-- License : BSD-like -- --- (c) Simon Marlow 2003 +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable -- - +-- Reading and writing the .haddock interface file +----------------------------------------------------------------------------- module Haddock.InterfaceFile ( InterfaceFile(..), diff --git a/src/Haddock/ModuleTree.hs b/src/Haddock/ModuleTree.hs index ef82dddb..d76f9883 100644 --- a/src/Haddock/ModuleTree.hs +++ b/src/Haddock/ModuleTree.hs @@ -1,8 +1,14 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.ModuleTree +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.ModuleTree ( ModuleTree(..), mkModuleTree ) where diff --git a/src/Haddock/Options.hs b/src/Haddock/Options.hs index 5e5bedd3..3f1b29b8 100644 --- a/src/Haddock/Options.hs +++ b/src/Haddock/Options.hs @@ -1,8 +1,16 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Options +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable -- +-- Definition of the command line interface of Haddock +----------------------------------------------------------------------------- module Haddock.Options ( diff --git a/src/Haddock/Types.hs b/src/Haddock/Types.hs index 9e6c746c..72bdef0c 100644 --- a/src/Haddock/Types.hs +++ b/src/Haddock/Types.hs @@ -1,12 +1,19 @@ {-# OPTIONS_HADDOCK hide #-} {-# LANGUAGE DeriveDataTypeable #-} - --- --- Haddock - A Haskell Documentation Tool +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Types +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- (c) Simon Marlow 2003 +-- Maintainer : haddock@projects.haskellorg +-- Stability : experimental +-- Portability : portable -- - +-- Types that are commonly used through-out Haddock. Some of the most +-- important types are defined here, like 'Interface' and 'DocName'. +----------------------------------------------------------------------------- module Haddock.Types where diff --git a/src/Haddock/Utils.hs b/src/Haddock/Utils.hs index a3679dba..439ed672 100644 --- a/src/Haddock/Utils.hs +++ b/src/Haddock/Utils.hs @@ -1,9 +1,15 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Utils +-- Copyright : (c) The University of Glasgow 2001-2002, +-- Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) The University of Glasgow 2001-2002 --- (c) Simon Marlow 2003 --- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Utils ( diff --git a/src/Haddock/Version.hs b/src/Haddock/Version.hs index 39715634..178e4811 100644 --- a/src/Haddock/Version.hs +++ b/src/Haddock/Version.hs @@ -1,8 +1,13 @@ +----------------------------------------------------------------------------- +-- | +-- Module : Haddock.Version +-- Copyright : (c) Simon Marlow 2003 +-- License : BSD-like -- --- Haddock - A Haskell Documentation Tool --- --- (c) Simon Marlow 2003 --- +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable +----------------------------------------------------------------------------- module Haddock.Version ( projectName, projectVersion, projectUrl diff --git a/src/Main.hs b/src/Main.hs index 6d85378a..0179115f 100644 --- a/src/Main.hs +++ b/src/Main.hs @@ -1,14 +1,20 @@ {-# OPTIONS_GHC -Wwarn #-} {-# LANGUAGE ForeignFunctionInterface, PatternSignatures #-} - --- --- Haddock - A Haskell Documentation Tool +----------------------------------------------------------------------------- +-- | +-- Module : Main +-- Copyright : (c) Simon Marlow 2003-2006, +-- David Waern 2006-2009 +-- License : BSD-like -- --- (c) Simon Marlow 2003 +-- Maintainer : haddock@projects.haskell.org +-- Stability : experimental +-- Portability : portable -- --- Ported to use the GHC API by David Waern during "Summer of Code" 2006 +-- Haddock - A Haskell Documentation Tool -- - +-- Program entry point and top-level code. +----------------------------------------------------------------------------- module Main (main) where -- cgit v1.2.3