-- 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.
--   
--   Given a module name and a name, it will find and display the
--   documentation of that name.
--   
--   <i>EXAMPLE USAGE</i>
--   
--   <pre>
--   $ haskell-docs Data.List.Split split
--   Split a list according to the given splitting strategy. This is
--    how to "run" a Splitter that has been built using the other
--    combinators.
--   </pre>
--   
--   <i>INSTALLATION</i>
--   
--   You should ensure that you have
--   
--   <pre>
--   documentation: True
--   </pre>
--   
--   in your .cabal/config so that the necessary .haddock files are
--   generated.
--   
--   Haddock is very sensitive to the GHC version. This program tries not
--   to be. If you cannot install this package due to a version problem,
--   open a Github issue. If the versions match up but the build fails,
--   open a Github issue. Neither case should arise.
--   
--   <i>USING WITH GHCI</i>
--   
--   <pre>
--   &gt; :def doc \input -&gt; return (":!haskell-docs " ++ input)
--   &gt; :doc System.IO getContents base
--   The getContents operation returns all user input as a single string,
--    which is read lazily as it is needed
--    (same as hGetContents stdin).
--   </pre>
--   
--   Add the above :def to your user .ghci to have it on start-up.
--   
--   <i>CONTRIBUTION AND ISSUES</i>
--   
--   Issues/ideas/contributions please make a Github issue:
--   <a>http://github.com/chrisdone/haskell-docs/issues</a>
@package haskell-docs
@version 3.0.2


-- | 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 -> [String] -> IO Bool

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

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

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

-- | Print the documentation from the given interface.
printWithInterface :: DynFlags -> Bool -> PackageConfig -> String -> ModuleName -> InstalledInterface -> Ghc Bool
printType :: GhcMonad m => DynFlags -> ModuleName -> t -> String -> m ()

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

-- | 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 -> Ghc 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 :: [String] -> (DynFlags -> Ghc a) -> IO a
run :: Ghc a -> IO a
showppr :: Outputable a => DynFlags -> a -> String
sdoc :: DynFlags -> SDoc -> String

-- | Wraps <a>showSDocForUser</a>.
showSDocForUser :: DynFlags -> PrintUnqualified -> SDoc -> String