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


-- | A program to find and display the docs of a name from a
given module.
--   
@package haskell-docs
@version 3.0.0


-- | Lookup the documentation of a name in a module (and in a specific
--   package in the case of ambiguity).
module Documentation.Haddock.Docs

-- | Print documentation with an initialized package set.
printDocumentationInitialized :: String -> ModuleName -> Maybe String -> IO Bool

-- | Print the documentation of a name in the given module.
printDocumentation :: DynFlags -> String -> ModuleName -> Maybe String -> Maybe PackageConfig -> IO Bool

-- | Show the package name e.g. base.
showPackageName :: PackageIdentifier -> String

-- | Print the documentation with the given package.
printWithPackage :: DynFlags -> Bool -> String -> ModuleName -> PackageConfig -> IO Bool

-- | Print the documentation from the given interface.
printWithInterface :: DynFlags -> Bool -> PackageConfig -> String -> InstalledInterface -> IO Bool

-- | Print the documentation of the arguments.
printArgs :: InstalledInterface -> String -> IO ()

-- | Indent after the first line.
indentAfter :: Int -> String -> String

-- | The module symbol doesn't actually exist in the module we intended, so
--   we descend into the module that it does exist in and restart our
--   search process.
descendSearch :: DynFlags -> String -> Name -> PackageConfig -> IO Bool

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

-- | Render the doc.
doc :: Doc String -> String
normalize :: [Char] -> [Char]

-- | Trim either side of a string.
trim :: [Char] -> [Char]

-- | Format an example to plain text.
formatExample :: Example -> String

-- | Get a mapping from names to doc string of that name from a Haddock
--   interface.
interfaceNameMap :: InstalledInterface -> Map String (Doc String)

-- | Get a mapping from names to doc string of that name from a Haddock
--   interface.
interfaceArgMap :: InstalledInterface -> Map String (Map Int (Doc Name))

-- | Search for a module's package, returning suggestions if not found.
getPackagesByModule :: DynFlags -> ModuleName -> IO (Either [Module] [PackageConfig])

-- | Get the Haddock interfaces of the given package.
getHaddockInterfacesByPackage :: PackageConfig -> IO [Either String InterfaceFile]

-- | Run an action with an initialized GHC package set.
withInitializedPackages :: (DynFlags -> IO a) -> IO a
run :: Ghc a -> IO a