Safe Haskell | None |
---|---|
Language | Haskell98 |
- hdocsy :: PackageDbStack -> [ModuleLocation] -> [String] -> GhcM [Map String String]
- hdocs :: PackageDbStack -> ModuleLocation -> [String] -> GhcM (Map String String)
- hdocsPackage :: PackageConfig -> GhcM (Map Text (Map Text Text))
- hdocsCabal :: PackageDbStack -> [String] -> GhcM [(ModulePackage, Map Text (Map Text Text))]
- setSymbolDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text Text -> Symbol -> m Symbol
- setDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text Text -> Module -> m Module
- setModuleDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text (Map Text Text) -> Module -> m Module
- hdocsProcess :: String -> [String] -> IO (Maybe (Map String String))
- readDocs :: Text -> [String] -> Path -> GhcM (Maybe (Map String String))
- readModuleDocs :: [String] -> Module -> GhcM (Maybe (Map String String))
- readProjectTargetDocs :: [String] -> Project -> [Path] -> GhcM (Map String (Map String String))
- hdocsSupported :: Bool
- module Control.Monad.Except
Documentation
hdocsy :: PackageDbStack -> [ModuleLocation] -> [String] -> GhcM [Map String String] Source #
Get docs for modules
hdocs :: PackageDbStack -> ModuleLocation -> [String] -> GhcM (Map String String) Source #
Get docs for module
hdocsPackage :: PackageConfig -> GhcM (Map Text (Map Text Text)) Source #
Get docs for package
hdocsCabal :: PackageDbStack -> [String] -> GhcM [(ModulePackage, Map Text (Map Text Text))] Source #
Get all docs
setSymbolDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text Text -> Symbol -> m Symbol Source #
Set docs for module
setDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text Text -> Module -> m Module Source #
Set docs for module symbols
setModuleDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text (Map Text Text) -> Module -> m Module Source #
Set docs for modules
readDocs :: Text -> [String] -> Path -> GhcM (Maybe (Map String String)) Source #
Read docs for one module
readModuleDocs :: [String] -> Module -> GhcM (Maybe (Map String String)) Source #
Read docs for one module
readProjectTargetDocs :: [String] -> Project -> [Path] -> GhcM (Map String (Map String String)) Source #
module Control.Monad.Except