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


-- | Haskell docs daemon
--   
--   Tool and library to get docs for installed packages and source files.
--   Can return result in JSON format.
--   
--   <pre>
--   Usage:
--   hdocs docs <a>module</a> - get docs for module/file
--   hdocs docs <a>module</a> <a>name</a> - get docs for name in module/file
--   flags
--   -j          --json         output json
--   -g GHC_OPT  --ghc=GHC_OPT  option to pass to GHC
--   </pre>
@package hdocs
@version 0.1.0.0

module HDocs.Module

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

-- | Docs state
type DocsM a = ErrorT String (StateT (Map String ModuleDocMap) IO) a

-- | Run docs monad
runDocsM :: DocsM a -> IO (Either String a)
withInitializedPackages :: (DynFlags -> IO a) -> IO a
configSession :: [String] -> IO DynFlags

-- | Load installed interface
moduleInterface :: DynFlags -> ModuleName -> IO [(PackageConfig, InstalledInterface)]
packageInterface :: DynFlags -> ModuleName -> PackageConfig -> IO [InstalledInterface]

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

-- | Load module documentation
moduleDocs :: [String] -> String -> DocsM ModuleDocMap

-- | Load file documentation
fileDocs :: [String] -> FilePath -> DocsM ModuleDocMap

-- | Load docs for file or module
docs :: [String] -> String -> DocsM ModuleDocMap
instance DocInterface Interface
instance DocInterface InstalledInterface