gendocs-0.1.3: Library for generating interface documentation from types

Safe HaskellSafe
LanguageHaskell2010

Data.Docs.Docs

Synopsis

Documentation

data Field Source #

Documentation for a record field

Constructors

Field 

Fields

Instances

Eq Field Source # 

Methods

(==) :: Field -> Field -> Bool #

(/=) :: Field -> Field -> Bool #

Show Field Source # 

Methods

showsPrec :: Int -> Field -> ShowS #

show :: Field -> String #

showList :: [Field] -> ShowS #

class Docs a where Source #

Can generate documentation for type

genDocs :: forall a. (Generic a, GTypeName (Rep a), Selectors (Rep a)) => Text -> Proxy a -> Documentation Source #

Create documentation for a type with only a description

genDocsEnum :: forall a. (Generic a, GTypeName (Rep a), Selectors (Rep a), Bounded a, Enum a, Show a) => Text -> Proxy a -> Documentation Source #

genValues :: forall a. (Enum a, Bounded a, Show a) => Proxy a -> [Text] Source #

genFields :: forall a. Selectors (Rep a) => FieldModifier -> Proxy a -> [Field] Source #