Documentation.Haddock.Docs

Lookup the documentation of a name in a module (and in a specific package in the case of ambiguity).

Documentation

printDocumentationInitialized :: String -> ModuleName -> Maybe String -> [String] -> IO Bool

Print documentation with an initialized package set.

printDocumentation :: DynFlags -> String -> ModuleName -> Maybe String -> Maybe PackageConfig -> Ghc Bool

Print the documentation of a name in the given module.

showPackageName :: PackageIdentifier -> String

Show the package name e.g. base.

printWithPackage :: DynFlags -> Bool -> String -> ModuleName -> PackageConfig -> Ghc Bool

Print the documentation with the given package.

printWithInterface :: DynFlags -> Bool -> PackageConfig -> String -> ModuleName -> InstalledInterface -> Ghc Bool

Print the documentation from the given interface.

printType :: GhcMonad m => DynFlags -> ModuleName -> t -> String -> m ()

printArgs :: InstalledInterface -> String -> Ghc ()

Print the documentation of the arguments.

indentAfter :: Int -> String -> String

Indent after the first line.

descendSearch :: DynFlags -> String -> Name -> PackageConfig -> Ghc Bool

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.

formatDoc :: Doc String -> String

Format some documentation to plain text.

doc :: Doc String -> String

Render the doc.

normalize :: [Char] -> [Char]

trim :: [Char] -> [Char]

Trim either side of a string.

formatExample :: Example -> String

Format an example to plain text.

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))

Get a mapping from names to doc string of that name from a Haddock interface.

getPackagesByModule :: DynFlags -> ModuleName -> IO (Either [Module] [PackageConfig])

Search for a module's package, returning suggestions if not found.

getHaddockInterfacesByPackage :: PackageConfig -> IO [Either String InterfaceFile]

Get the Haddock interfaces of the given package.

withInitializedPackages :: [String] -> (DynFlags -> Ghc a) -> IO a

Run an action with an initialized GHC package set.

run :: Ghc a -> IO a

showppr :: Outputable a => DynFlags -> a -> String

sdoc :: DynFlags -> SDoc -> String

showSDocForUser :: DynFlags -> PrintUnqualified -> SDoc -> String

Wraps showSDocForUser.