hsdev-0.3.4.0: Haskell development library
Safe HaskellNone
LanguageHaskell2010

HsDev.Symbols.Documented

Synopsis

Documentation

class Documented a where Source #

Documented symbol

Minimal complete definition

brief

Methods

brief :: a -> Text Source #

detailed :: a -> Text Source #

default detailed :: Sourced a => a -> Text Source #

Instances

Instances details
Documented Project Source # 
Instance details

Defined in HsDev.Symbols.Documented

Methods

brief :: Project -> Text Source #

detailed :: Project -> Text Source #

Documented ModulePackage Source # 
Instance details

Defined in HsDev.Symbols.Documented

Methods

brief :: ModulePackage -> Text Source #

detailed :: ModulePackage -> Text Source #

Documented ModuleLocation Source # 
Instance details

Defined in HsDev.Symbols.Documented

Methods

brief :: ModuleLocation -> Text Source #

detailed :: ModuleLocation -> Text Source #

Documented ModuleId Source # 
Instance details

Defined in HsDev.Symbols.Types

Methods

brief :: ModuleId -> Text Source #

detailed :: ModuleId -> Text Source #

Documented SymbolId Source # 
Instance details

Defined in HsDev.Symbols.Types

Methods

brief :: SymbolId -> Text Source #

detailed :: SymbolId -> Text Source #

Documented Symbol Source # 
Instance details

Defined in HsDev.Symbols.Types

Methods

brief :: Symbol -> Text Source #

detailed :: Symbol -> Text Source #

Documented Module Source # 
Instance details

Defined in HsDev.Symbols.Types

Methods

brief :: Module -> Text Source #

detailed :: Module -> Text Source #

Documented HayooSymbol Source # 
Instance details

Defined in HsDev.Tools.Hayoo

Methods

brief :: HayooSymbol -> Text Source #

detailed :: HayooSymbol -> Text Source #

defaultDetailed :: (Sourced a, Documented a) => a -> [Text] Source #

Default detailed docs