Data.Docs

Documentation

data Documentation

Documentation for a given type

Constructors

Documentation

Fields

• typeName :: TypeName
• fields :: [Field]
• description :: Text
• enumeratedValues :: [Text]

Instances

Eq Documentation

Methods

(==) :: Documentation -> Documentation -> Bool

(/=) :: Documentation -> Documentation -> Bool

Show Documentation

Methods

showsPrec :: Int -> Documentation -> ShowS

show :: Documentation -> String

showList :: [Documentation] -> ShowS

data Field

Documentation for a record field

Constructors

Field

Fields

• fieldName :: FieldName
• fieldType :: TypeName
• isRequired :: Bool

Instances

Eq Field

Methods

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

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

Show Field

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

class Docs a where

Can generate documentation for type

Methods

docs :: Proxy a -> Documentation

docs :: (Generic a, GTypeName (Rep a), Selectors (Rep a)) => Proxy a -> Documentation

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

Create documentation for a type with only a description

genDocsWith :: forall a. (Generic a, GTypeName (Rep a), Selectors (Rep a)) => FieldModifier -> Text -> Proxy a -> Documentation

type FieldModifier = String -> String

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

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

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

class Sample a where

Minimal complete definition

sample

Methods

sample :: Proxy a -> a

samples :: Proxy a -> [a]

markdown :: (ToJSON a, Docs a, Sample a) => Proxy a -> Text

Generate markdown documentation