-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haskell docs tool
--   
--   Tool and library to get docs for installed packages and source files.
--   Can return result in JSON format. Can dump docs for all installed
--   modules
--   
--   <pre>
--   Usage:
--   hdocs <a>module</a> - get docs for module/file
--   hdocs <a>module</a> <a>name</a> - get docs for name in module/file
--   hdocs dump [r] - dump all installed docs, if [r], find docs for reexported declarations
--   flags
--   -g GHC_OPT  --ghc=GHC_OPT  option to pass to GHC
--   </pre>
@package hdocs
@version 0.4.4.0

module HDocs.Base

-- | Documentation in module
type ModuleDocMap = Map String (Doc String)

-- | Run action with initialized packages
withInitializedPackages :: [String] -> (DynFlags -> IO a) -> IO a

-- | Config GHC session
configSession :: [String] -> IO DynFlags

-- | Format documentation to plain text.
formatDoc :: Doc String -> String

-- | Format docs to plain text
formatDocs :: ModuleDocMap -> Map String String

module HDocs.Haddock

-- | Read all installed docs
readInstalledDocs :: [String] -> ExceptT String IO (Map String ModuleDocMap)

-- | Read docs from .haddock file
readHaddock :: FilePath -> ExceptT String IO (Map String ModuleDocMap)

-- | Read docs for haskell modules
readSources :: [String] -> [FilePath] -> ExceptT String IO (Map String ModuleDocMap)

-- | Read docs for haskell modules
readSources_ :: [String] -> [FilePath] -> ExceptT String IO [(String, ModuleDocMap)]

-- | Read docs for haskell module
readSource :: [String] -> FilePath -> ExceptT String IO (String, ModuleDocMap)

-- | Read docs for source in Ghc monad
readSourcesGhc :: [String] -> [FilePath] -> ExceptT String Ghc [(String, ModuleDocMap)]

-- | Get docs for <a>InstalledInterface</a>
installedInterfaceDocs :: InstalledInterface -> (String, ModuleDocMap)

-- | Get docs for <a>InstalledInterface</a>s
installedInterfacesDocs :: [InstalledInterface] -> Map String ModuleDocMap

-- | Get docs for <a>Interface</a>
interfaceDocs :: Interface -> (String, ModuleDocMap)

-- | Get list of haddock files in package db
haddockFiles :: [String] -> ExceptT String IO [FilePath]

-- | Read installed interface
readInstalledInterfaces :: FilePath -> ExceptT String IO [InstalledInterface]

-- | Read installed interfaces for package
readPackageInterfaces :: PackageConfig -> ExceptT String IO [InstalledInterface]

-- | Lookup doc
lookupDoc :: String -> String -> Map String ModuleDocMap -> Maybe (Doc String)

-- | Lookup doc for Name
lookupNameDoc :: Name -> Map String ModuleDocMap -> Maybe (Doc String)

-- | A minimal implementation of a <a>GhcMonad</a>. If you need a custom
--   monad, e.g., to maintain additional state consider wrapping this monad
--   or using <a>GhcT</a>.
data Ghc a :: * -> *

module HDocs.Module

-- | Load docs for all exported module symbols
moduleDocs :: [String] -> String -> ExceptT String IO ModuleDocMap

-- | Load docs for all installed modules
installedDocs :: [String] -> ExceptT String IO (Map String ModuleDocMap)

-- | Get docs for <a>InstalledInterface</a> with its exports docs
exportsDocs :: Map String ModuleDocMap -> InstalledInterface -> (String, ModuleDocMap)