Add missing Haddock documentation.

Author: mpilgrem

src/Stack/BuildInfo.hs

@@ -37,6 +37,7 @@ import           Stack.Prelude
 import           Stack.Types.Version ( showStackVersion )
 #endif
 
+-- | The output of @stack --version@.
 versionString' :: String
 #ifdef USE_GIT_INFO
 versionString' = concat $ concat

src/Stack/Config/ConfigureScript.hs

@@ -17,6 +17,8 @@ import           Stack.DefaultColorWhen ( defaultColorWhen )
 import           Stack.Prelude
 import           RIO.Process ( HasProcessContext, withWorkingDir )
 
+-- | For the given directory, yields an action that trys to generate a
+-- @configure@ script with @autoreconf@, if one does not exist in the directory.
 ensureConfigureScript ::
      (HasProcessContext env, HasTerm env)
   => Path b Dir

src/Stack/PackageFile.hs

@@ -166,6 +166,8 @@ getPackageFile pkg cabalFP =
           moreBuildFiles <> packageComponentFile.packageExtraFile
       }
 
+-- | For the given contents of a Cabal file, yields the information from it that
+-- Stack needs to track files.
 stackPackageFileFromCabal :: Cabal.PackageDescription -> StackPackageFile
 stackPackageFileFromCabal cabalPkg =
   StackPackageFile

src/Stack/Types/AddCommand.hs

@@ -16,6 +16,12 @@ import           Stack.Prelude
 import           Stack.Types.GlobalOptsMonoid ( GlobalOptsMonoid )
 import           Stack.Types.Runner ( Runner )
 
+-- | A type synonym for the monad used to add command line commands to Stack.
+-- The monad is a stack of an 'ExceptT' @(@t'RIO' 'Runner' @())@ monad on top of
+-- a 'Writer' @f@ monad, where @f@ is
+-- 'Options.Applicative.Mod' 'Options.Applicative.CommandFields' @(@t'RIO' 'Runner' @(),@ 'GlobalOptsMonoid'@)@ - that
+-- is, an option modifier for command options that have return type
+-- @(@t'RIO' 'Runner' @(),@ 'GlobalOptsMonoid'@)@.
 type AddCommand =
   ExceptT (RIO Runner ())
           (Writer (OA.Mod OA.CommandFields (RIO Runner (), GlobalOptsMonoid)))

src/Stack/Types/Cache.hs

@@ -54,6 +54,8 @@ instance PersistField ConfigCacheType where
 instance PersistFieldSql ConfigCacheType where
   sqlType _ = SqlString
 
+-- | Type representing actions for which the last time the action was performed
+-- should be cached.
 data Action
   = UpgradeCheck
   deriving (Eq, Ord, Show)

src/Stack/Types/Config/Exception.hs

@@ -255,6 +255,8 @@ instance Pretty ConfigPrettyException where
 
 instance Exception ConfigPrettyException
 
+-- | Type representing an exception thrown by functions exported by the
+-- "Stack.Config" module.
 data ParseAbsolutePathException
   = ParseAbsolutePathException String String
   deriving (Show, Typeable)

src/Stack/Types/DotConfig.hs

@@ -24,6 +24,7 @@ import           Stack.Types.Platform ( HasPlatform (..) )
 import           Stack.Types.Runner ( HasRunner (..) )
 import           Stack.Types.SourceMap ( SourceMap (..) )
 
+-- | Type representing configurations for the creation of a dependency graph.
 data DotConfig = DotConfig
   { buildConfig :: !BuildConfig
   , sourceMap :: !SourceMap

src/Stack/Types/GhcOptionKey.hs

@@ -14,12 +14,19 @@ import           Data.Aeson.Types ( FromJSONKey (..), FromJSONKeyFunction (..) )
 import qualified Data.Text as T
 import           Stack.Prelude
 
+-- | Type representing scopes of the application by Stack of GHC options.
 data GhcOptionKey
   = GOKOldEverything
+    -- ^ All packages, project packages or otherwise (specified with legacy
+    -- syntax).
   | GOKEverything
+    -- ^ All packages, project packages or otherwise.
   | GOKLocals
+    -- ^ All project packages, targets or otherwise.
   | GOKTargets
+    -- ^ All project packages that are targets.
   | GOKPackage !PackageName
+    -- ^ A named package.
   deriving (Eq, Ord)
 
 instance FromJSONKey GhcOptionKey where

src/Stack/Types/GhcOptions.hs

@@ -15,6 +15,7 @@ import           Data.Attoparsec.Args ( EscapingMode (Escaping), parseArgs )
 import qualified Data.Text as T
 import           Stack.Prelude
 
+-- | Type representing lists of GHC options.
 newtype GhcOptions = GhcOptions { ghcOptions :: [Text] }
 
 instance FromJSON GhcOptions where

src/Stack/Types/GlobalOpts.hs

@@ -51,6 +51,8 @@ data GlobalOpts = GlobalOpts
     -- available.
   }
 
+-- | View or set the @buildOpts@ field of the @configMonoid@ field of a
+-- v'GlobalOpts'.
 globalOptsBuildOptsMonoidL :: Lens' GlobalOpts BuildOptsMonoid
 globalOptsBuildOptsMonoidL =
     lens (.configMonoid) (\x y -> x { configMonoid = y })