HsDev.Symbols.Documented

Documentation

class Documented a where

Documented symbol

Minimal complete definition

brief

Methods

brief :: a -> Text

detailed :: a -> Text

detailed :: Sourced a => a -> Text

Instances

Documented Project

Methods

brief :: Project -> Text

detailed :: Project -> Text

Documented ModulePackage

Methods

brief :: ModulePackage -> Text

detailed :: ModulePackage -> Text

Documented ModuleLocation

Methods

brief :: ModuleLocation -> Text

detailed :: ModuleLocation -> Text

Documented Symbol

Methods

brief :: Symbol -> Text

detailed :: Symbol -> Text

Documented Module

Methods

brief :: Module -> Text

detailed :: Module -> Text

Documented HayooSymbol

Methods

brief :: HayooSymbol -> Text

detailed :: HayooSymbol -> Text

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

Default detailed docs