Safe Haskell	None
Language	Haskell2010

Lorentz.Doc

Contents

Re-exports
Orphan instances

Synopsis

doc :: DocItem di => di -> s :-> s
docGroup :: DocGrouping -> (inp :-> out) -> inp :-> out
docStorage :: forall storage s. TypeHasDoc storage => s :-> s
buildLorentzDoc :: (inp :-> out) -> ContractDoc
buildLorentzDocWithGitRev :: DGitRevision -> (inp :-> out) -> ContractDoc
renderLorentzDoc :: (inp :-> out) -> LText
contractName :: Text -> (inp :-> out) -> inp :-> out
contractGeneral :: (inp :-> out) -> inp :-> out
contractGeneralDefault :: s :-> s
cutLorentzNonDoc :: (inp :-> out) -> s :-> s
type Markdown = Builder
class (Typeable d, DOrd d, KnownNat (DocItemPosition d)) => DocItem d where
- type DocItemPosition d = (pos :: Nat) | pos -> d
- type DocItemPlacement d :: DocItemPlacementKind
- docItemSectionName :: Maybe Text
- docItemSectionDescription :: Maybe Markdown
- docItemSectionNameStyle :: DocSectionNameStyle
- docItemRef :: d -> DocItemRef (DocItemPlacement d)
- docItemToMarkdown :: HeaderLevel -> d -> Markdown
- docItemDependencies :: d -> [SomeDocDefinitionItem]
- docItemsOrder :: [d] -> [d]
docItemPosition :: DocItem d => DocItemPos
newtype DocItemId = DocItemId Text
data DocItemPlacementKind
- = DocItemInlined
- | DocItemInDefinitions
data DocItemRef (p :: DocItemPlacementKind) where
- DocItemRef :: DocItemId -> DocItemRef 'DocItemInDefinitions
- DocItemNoRef :: DocItemRef 'DocItemInlined
data DocSectionNameStyle
- = DocSectionNameBig
- | DocSectionNameSmall
data SomeDocItem where
- SomeDocItem :: forall d. DocItem d => d -> SomeDocItem
data SomeDocDefinitionItem where
- SomeDocDefinitionItem :: forall d. (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => d -> SomeDocDefinitionItem
newtype SubDoc = SubDoc DocBlock
type DocGrouping = SubDoc -> SomeDocItem
data ContractDoc = ContractDoc {
- cdContents :: DocBlock
- cdDefinitions :: DocBlock
- cdDefinitionsSet :: Set SomeDocDefinitionItem
- cdDefinitionIds :: Set DocItemId
}
data DDescription = DDescription Markdown
data DGitRevision
- = DGitRevisionKnown DGitRevisionInfo
- | DGitRevisionUnknown
newtype GitRepoSettings = GitRepoSettings {
- grsMkGitRevision :: Text -> Text
}
mkDGitRevision :: ExpQ
morleyRepoSettings :: GitRepoSettings
data DComment = DComment Text
data DAnchor = DAnchor Anchor
data DType where
- DType :: forall a. TypeHasDoc a => Proxy a -> DType
dTypeDep :: TypeHasDoc t => SomeDocDefinitionItem
docDefinitionRef :: (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => Markdown -> d -> Markdown
contractDocToMarkdown :: ContractDoc -> LText
subDocToMarkdown :: HeaderLevel -> SubDoc -> Markdown
class (Typeable a, SingI (TypeDocFieldDescriptions a), FieldDescriptionsValid (TypeDocFieldDescriptions a) a) => TypeHasDoc a where
- type TypeDocFieldDescriptions a :: FieldDescriptions
- typeDocName :: Proxy a -> Text
- typeDocMdDescription :: Markdown
- typeDocMdReference :: Proxy a -> WithinParens -> Markdown
- typeDocDependencies :: Proxy a -> [SomeDocDefinitionItem]
- typeDocHaskellRep :: TypeDocHaskellRep a
- typeDocMichelsonRep :: TypeDocMichelsonRep a
data SomeTypeWithDoc where
- SomeTypeWithDoc :: forall td. TypeHasDoc td => Proxy td -> SomeTypeWithDoc
class HaveCommonTypeCtor (a :: k) (b :: k1)
class IsHomomorphic (a :: k)
genericTypeDocDependencies :: (Generic a, GTypeHasDoc (Rep a)) => Proxy a -> [SomeDocDefinitionItem]
customTypeDocMdReference :: (Text, DType) -> [DType] -> WithinParens -> Markdown
homomorphicTypeDocMdReference :: (Typeable t, TypeHasDoc t, IsHomomorphic t) => Proxy t -> WithinParens -> Markdown
poly1TypeDocMdReference :: forall (t :: Type -> Type) r a. (r ~ t a, Typeable t, Each '[TypeHasDoc] '[r, a], IsHomomorphic t) => Proxy r -> WithinParens -> Markdown
poly2TypeDocMdReference :: forall (t :: Type -> Type -> Type) r a b. (r ~ t a b, Typeable t, Each '[TypeHasDoc] '[r, a, b], IsHomomorphic t) => Proxy r -> WithinParens -> Markdown
homomorphicTypeDocHaskellRep :: (Generic a, GTypeHasDoc (Rep a)) => TypeDocHaskellRep a
concreteTypeDocHaskellRep :: (Typeable a, GenericIsoValue a, GTypeHasDoc (Rep a), HaveCommonTypeCtor b a) => TypeDocHaskellRep b
concreteTypeDocHaskellRepUnsafe :: (Typeable a, GenericIsoValue a, GTypeHasDoc (Rep a)) => TypeDocHaskellRep b
haskellRepNoFields :: TypeDocHaskellRep a -> TypeDocHaskellRep a
haskellRepStripFieldPrefix :: HasCallStack => TypeDocHaskellRep a -> TypeDocHaskellRep a
homomorphicTypeDocMichelsonRep :: SingI (ToT a) => TypeDocMichelsonRep a
concreteTypeDocMichelsonRep :: forall k a (b :: k). (Typeable a, SingI (ToT a), HaveCommonTypeCtor b a) => TypeDocMichelsonRep b
concreteTypeDocMichelsonRepUnsafe :: forall k a (b :: k). (Typeable a, SingI (ToT a)) => TypeDocMichelsonRep b

Documentation

doc :: DocItem di => di -> s :-> s Source #

Put a document item.

docGroup :: DocGrouping -> (inp :-> out) -> inp :-> out Source #

Group documentation built in the given piece of code into block dedicated to one thing, e.g. to one entrypoint.

docStorage :: forall storage s. TypeHasDoc storage => s :-> s Source #

Insert documentation of the contract storage type. The type should be passed using type applications.

buildLorentzDoc :: (inp :-> out) -> ContractDoc Source #

buildLorentzDocWithGitRev :: DGitRevision -> (inp :-> out) -> ContractDoc Source #

renderLorentzDoc :: (inp :-> out) -> LText Source #

contractName :: Text -> (inp :-> out) -> inp :-> out Source #

Give a name to given contract. Apply it to the whole contract code.

contractGeneral :: (inp :-> out) -> inp :-> out Source #

Takes an instruction that inserts documentation items with general information about the contract. Inserts it into general section. See DGeneralInfoSection.

contractGeneralDefault :: s :-> s Source #

Inserts general information about the contract using the default format.

Currently we only include git revision. It is unknown in the library code and is supposed to be updated in an executable.

cutLorentzNonDoc :: (inp :-> out) -> s :-> s Source #

Leave only instructions related to documentation.

This function is useful when your method executes a lambda coming from outside, but you know its properties and want to propagate its documentation to your contract code.

Re-exports

type Markdown = Builder #

A piece of markdown document.

This is opposed to Text type, which in turn is not supposed to contain markup elements.

class (Typeable d, DOrd d, KnownNat (DocItemPosition d)) => DocItem d where #

A piece of documentation describing one property of a thing, be it a name or description of a contract, or an error throwable by given endpoint.

Items of the same type appear close to each other in a rendered documentation and form a section.

Doc items are later injected into a contract code via a dedicated nop-like instruction. Normally doc items which belong to one section appear in resulting doc in the same order in which they appeared in the contract.

While documentation framework grows, this typeclass acquires more and more methods for fine tuning of existing rendering logic because we don't want to break backward compatibility, hope one day we will make everything concise :( E.g. all rendering and reording stuff could be merged in one method, and we could have several template implementations for it which would allow user to specify only stuff relevant to his case.

Minimal complete definition

docItemSectionName, docItemToMarkdown

Associated Types

type DocItemPosition d = (pos :: Nat) | pos -> d #

Position of this item in the resulting documentation; the smaller the value, the higher the section with this element will be placed.

Documentation structure is not necessarily flat. If some doc item consolidates a whole documentation block within it, this block will have its own placement of items independent from outer parts of the doc.

type DocItemPlacement d :: DocItemPlacementKind #

Defines where given doc item should be put. There are two options: 1. Inline right here (default behaviour); 2. Put into definitions section.

Note that we require all doc items with "in definitions" placement to have Eq and Ord instances which comply the following law: if two documentation items describe the same entity or property, they should be considered equal.

type DocItemPlacement d = 'DocItemInlined #

Methods

docItemSectionName :: Maybe Text #

When multiple items of the same type belong to one section, how this section will be called.

If not provided, section will contain just untitled content.

docItemSectionDescription :: Maybe Markdown #

Description of a section.

Can be used to mention some common things about all elements of this section. Markdown syntax is permitted here.

docItemSectionNameStyle :: DocSectionNameStyle #

How to render section name.

Takes effect only if section name is set.

docItemRef :: d -> DocItemRef (DocItemPlacement d) #

Defines a function which constructs an unique identifier of given doc item, if it has been decided to put the doc item into definitions section.

Identifier should be unique both among doc items of the same type and items of other types. Thus, consider using "typeId-contentId" pattern.

docItemToMarkdown :: HeaderLevel -> d -> Markdown #

Render given doc item to Markdown, preferably one line, optionally with header.

Accepts the smallest allowed level of header. (Using smaller value than provided one will interfere with existing headers thus delivering mess).

docItemDependencies :: d -> [SomeDocDefinitionItem] #

All doc items which this doc item refers to.

They will automatically be put to definitions as soon as given doc item is detected.

docItemsOrder :: [d] -> [d] #

This function accepts doc items put under the same section in the order in which they appeared in the contract and returns their new desired order. It's also fine to use this function for filtering or merging doc items.

Default implementation * leaves inlined items as is; * for items put to definitions, lexicographically sorts them by their id.

Instances

Instances details

DocItem DType
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPosition DType = (pos :: Nat) # type DocItemPlacement DType :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DType -> DocItemRef (DocItemPlacement DType) # docItemToMarkdown :: HeaderLevel -> DType -> Markdown # docItemDependencies :: DType -> [SomeDocDefinitionItem] # docItemsOrder :: [DType] -> [DType] #
DocItem DStorageType
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPosition DStorageType = (pos :: Nat) # type DocItemPlacement DStorageType :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DStorageType -> DocItemRef (DocItemPlacement DStorageType) # docItemToMarkdown :: HeaderLevel -> DStorageType -> Markdown # docItemDependencies :: DStorageType -> [SomeDocDefinitionItem] # docItemsOrder :: [DStorageType] -> [DStorageType] #
DocItem DGeneralInfoSection
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DGeneralInfoSection = (pos :: Nat) # type DocItemPlacement DGeneralInfoSection :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DGeneralInfoSection -> DocItemRef (DocItemPlacement DGeneralInfoSection) # docItemToMarkdown :: HeaderLevel -> DGeneralInfoSection -> Markdown # docItemDependencies :: DGeneralInfoSection -> [SomeDocDefinitionItem] # docItemsOrder :: [DGeneralInfoSection] -> [DGeneralInfoSection] #
DocItem DName
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DName = (pos :: Nat) # type DocItemPlacement DName :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DName -> DocItemRef (DocItemPlacement DName) # docItemToMarkdown :: HeaderLevel -> DName -> Markdown # docItemDependencies :: DName -> [SomeDocDefinitionItem] # docItemsOrder :: [DName] -> [DName] #
DocItem DDescription
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DDescription = (pos :: Nat) # type DocItemPlacement DDescription :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DDescription -> DocItemRef (DocItemPlacement DDescription) # docItemToMarkdown :: HeaderLevel -> DDescription -> Markdown # docItemDependencies :: DDescription -> [SomeDocDefinitionItem] # docItemsOrder :: [DDescription] -> [DDescription] #
DocItem DGitRevision
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DGitRevision = (pos :: Nat) # type DocItemPlacement DGitRevision :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DGitRevision -> DocItemRef (DocItemPlacement DGitRevision) # docItemToMarkdown :: HeaderLevel -> DGitRevision -> Markdown # docItemDependencies :: DGitRevision -> [SomeDocDefinitionItem] # docItemsOrder :: [DGitRevision] -> [DGitRevision] #
DocItem DComment
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DComment = (pos :: Nat) # type DocItemPlacement DComment :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DComment -> DocItemRef (DocItemPlacement DComment) # docItemToMarkdown :: HeaderLevel -> DComment -> Markdown # docItemDependencies :: DComment -> [SomeDocDefinitionItem] # docItemsOrder :: [DComment] -> [DComment] #
DocItem DAnchor
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DAnchor = (pos :: Nat) # type DocItemPlacement DAnchor :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DAnchor -> DocItemRef (DocItemPlacement DAnchor) # docItemToMarkdown :: HeaderLevel -> DAnchor -> Markdown # docItemDependencies :: DAnchor -> [SomeDocDefinitionItem] # docItemsOrder :: [DAnchor] -> [DAnchor] #
DocItem DUStoreTemplate Source #
Instance details Defined in Lorentz.UStore.Doc Associated Types type DocItemPosition DUStoreTemplate = (pos :: Nat) # type DocItemPlacement DUStoreTemplate :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DUStoreTemplate -> DocItemRef (DocItemPlacement DUStoreTemplate) # docItemToMarkdown :: HeaderLevel -> DUStoreTemplate -> Markdown # docItemDependencies :: DUStoreTemplate -> [SomeDocDefinitionItem] # docItemsOrder :: [DUStoreTemplate] -> [DUStoreTemplate] #
DocItem DThrows Source #
Instance details Defined in Lorentz.Errors Associated Types type DocItemPosition DThrows = (pos :: Nat) # type DocItemPlacement DThrows :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DThrows -> DocItemRef (DocItemPlacement DThrows) # docItemToMarkdown :: HeaderLevel -> DThrows -> Markdown # docItemDependencies :: DThrows -> [SomeDocDefinitionItem] # docItemsOrder :: [DThrows] -> [DThrows] #
DocItem DError Source #
Instance details Defined in Lorentz.Errors Associated Types type DocItemPosition DError = (pos :: Nat) # type DocItemPlacement DError :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DError -> DocItemRef (DocItemPlacement DError) # docItemToMarkdown :: HeaderLevel -> DError -> Markdown # docItemDependencies :: DError -> [SomeDocDefinitionItem] # docItemsOrder :: [DError] -> [DError] #
DocItem DMigrationActionDesc Source #
Instance details Defined in Lorentz.UStore.Migration.Base Associated Types type DocItemPosition DMigrationActionDesc = (pos :: Nat) # type DocItemPlacement DMigrationActionDesc :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DMigrationActionDesc -> DocItemRef (DocItemPlacement DMigrationActionDesc) # docItemToMarkdown :: HeaderLevel -> DMigrationActionDesc -> Markdown # docItemDependencies :: DMigrationActionDesc -> [SomeDocDefinitionItem] # docItemsOrder :: [DMigrationActionDesc] -> [DMigrationActionDesc] #
DocItem DDescribeErrorTagMap Source #
Instance details Defined in Lorentz.Errors.Numeric.Doc Associated Types type DocItemPosition DDescribeErrorTagMap = (pos :: Nat) # type DocItemPlacement DDescribeErrorTagMap :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DDescribeErrorTagMap -> DocItemRef (DocItemPlacement DDescribeErrorTagMap) # docItemToMarkdown :: HeaderLevel -> DDescribeErrorTagMap -> Markdown # docItemDependencies :: DDescribeErrorTagMap -> [SomeDocDefinitionItem] # docItemsOrder :: [DDescribeErrorTagMap] -> [DDescribeErrorTagMap] #
DocItem DEntryPointArg Source #
Instance details Defined in Lorentz.EntryPoints.Doc Associated Types type DocItemPosition DEntryPointArg = (pos :: Nat) # type DocItemPlacement DEntryPointArg :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntryPointArg -> DocItemRef (DocItemPlacement DEntryPointArg) # docItemToMarkdown :: HeaderLevel -> DEntryPointArg -> Markdown # docItemDependencies :: DEntryPointArg -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntryPointArg] -> [DEntryPointArg] #
DocItem DEntryPointReference Source #
Instance details Defined in Lorentz.EntryPoints.Doc Associated Types type DocItemPosition DEntryPointReference = (pos :: Nat) # type DocItemPlacement DEntryPointReference :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntryPointReference -> DocItemRef (DocItemPlacement DEntryPointReference) # docItemToMarkdown :: HeaderLevel -> DEntryPointReference -> Markdown # docItemDependencies :: DEntryPointReference -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntryPointReference] -> [DEntryPointReference] #
DocItem (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc Associated Types type DocItemPosition (DEntryPoint PlainEntryPointsKind) = (pos :: Nat) # type DocItemPlacement (DEntryPoint PlainEntryPointsKind) :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DEntryPoint PlainEntryPointsKind -> DocItemRef (DocItemPlacement (DEntryPoint PlainEntryPointsKind)) # docItemToMarkdown :: HeaderLevel -> DEntryPoint PlainEntryPointsKind -> Markdown # docItemDependencies :: DEntryPoint PlainEntryPointsKind -> [SomeDocDefinitionItem] # docItemsOrder :: [DEntryPoint PlainEntryPointsKind] -> [DEntryPoint PlainEntryPointsKind] #

docItemPosition :: DocItem d => DocItemPos #

Get doc item position at term-level.

newtype DocItemId #

Some unique identifier of a doc item.

All doc items which should be refer-able need to have this identifier.

Constructors

DocItemId Text

Instances

Instances details

Eq DocItemId
Instance details Defined in Michelson.Doc Methods (==) :: DocItemId -> DocItemId -> Bool # (/=) :: DocItemId -> DocItemId -> Bool #
Ord DocItemId
Instance details Defined in Michelson.Doc Methods compare :: DocItemId -> DocItemId -> Ordering # (<) :: DocItemId -> DocItemId -> Bool # (<=) :: DocItemId -> DocItemId -> Bool # (>) :: DocItemId -> DocItemId -> Bool # (>=) :: DocItemId -> DocItemId -> Bool # max :: DocItemId -> DocItemId -> DocItemId # min :: DocItemId -> DocItemId -> DocItemId #
Show DocItemId
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocItemId -> ShowS # show :: DocItemId -> String # showList :: [DocItemId] -> ShowS #
ToAnchor DocItemId
Instance details Defined in Michelson.Doc Methods toAnchor :: DocItemId -> Anchor #

data DocItemPlacementKind #

Where do we place given doc item.

Constructors

DocItemInlined	Placed in the document content itself.
DocItemInDefinitions	Placed in dedicated definitions section; can later be referenced.

data DocItemRef (p :: DocItemPlacementKind) where #

Defines an identifier which given doc item can be referenced with.

Constructors

DocItemRef :: DocItemId -> DocItemRef 'DocItemInDefinitions
DocItemNoRef :: DocItemRef 'DocItemInlined

Instances

Instances details

ToAnchor (DocItemRef 'DocItemInDefinitions)
Instance details Defined in Michelson.Doc Methods toAnchor :: DocItemRef 'DocItemInDefinitions -> Anchor #

data DocSectionNameStyle #

How to render section name.

Constructors

DocSectionNameBig	Suitable for block name.
DocSectionNameSmall	Suitable for subsection title within block.

data SomeDocItem where #

Hides some documentation item.

Constructors

SomeDocItem :: forall d. DocItem d => d -> SomeDocItem

Instances

Instances details

Show DocGrouping
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocGrouping -> ShowS # show :: DocGrouping -> String # showList :: [DocGrouping] -> ShowS #
Show SomeDocItem	To automatically derive `instance Show Michelson.Typed.Instr` later.
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> SomeDocItem -> ShowS # show :: SomeDocItem -> String # showList :: [SomeDocItem] -> ShowS #
NFData SomeDocItem
Instance details Defined in Michelson.Doc Methods rnf :: SomeDocItem -> () #

data SomeDocDefinitionItem where #

Hides some documentation item which is put to "definitions" section.

Constructors

SomeDocDefinitionItem :: forall d. (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => d -> SomeDocDefinitionItem

Instances

Instances details

Eq SomeDocDefinitionItem
Instance details Defined in Michelson.Doc Methods (==) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (/=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool #
Ord SomeDocDefinitionItem
Instance details Defined in Michelson.Doc Methods compare :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Ordering # (<) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (<=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (>) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # (>=) :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> Bool # max :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> SomeDocDefinitionItem # min :: SomeDocDefinitionItem -> SomeDocDefinitionItem -> SomeDocDefinitionItem #

newtype SubDoc #

A part of documentation to be grouped. Essentially incapsulates DocBlock.

Constructors

SubDoc DocBlock

Instances

Instances details

Show DocGrouping
Instance details Defined in Michelson.Doc Methods showsPrec :: Int -> DocGrouping -> ShowS # show :: DocGrouping -> String # showList :: [DocGrouping] -> ShowS #

type DocGrouping = SubDoc -> SomeDocItem #

A function which groups a piece of doc under one doc item.

data ContractDoc #

Keeps documentation gathered for some piece of contract code.

Used for building documentation of a contract.

Constructors

ContractDoc

Fields

cdContents :: DocBlock
All inlined doc items.
cdDefinitions :: DocBlock
Definitions used in document.
Usually you put some large and repetitive descriptions here. This differs from the document content in that it contains sections which are always at top-level, disregard the nesting.
All doc items which define docItemId method go here, and only they.
cdDefinitionsSet :: Set SomeDocDefinitionItem
We remember all already declared entries to avoid cyclic dependencies in documentation items discovery.
cdDefinitionIds :: Set DocItemId
We remember all already used identifiers. (Documentation naturally should not declare multiple items with the same identifier because that would make references to the respective anchors ambiguous).

Instances

Instances details

Semigroup ContractDoc	Contract documentation assembly primarily relies on this instance.
Instance details Defined in Michelson.Doc Methods (<>) :: ContractDoc -> ContractDoc -> ContractDoc # sconcat :: NonEmpty ContractDoc -> ContractDoc # stimes :: Integral b => b -> ContractDoc -> ContractDoc #
Monoid ContractDoc
Instance details Defined in Michelson.Doc Methods mempty :: ContractDoc # mappend :: ContractDoc -> ContractDoc -> ContractDoc # mconcat :: [ContractDoc] -> ContractDoc #

data DDescription #

Description of something.

Constructors

DDescription Markdown

Instances

Instances details

DocItem DDescription
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DDescription = (pos :: Nat) # type DocItemPlacement DDescription :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DDescription -> DocItemRef (DocItemPlacement DDescription) # docItemToMarkdown :: HeaderLevel -> DDescription -> Markdown # docItemDependencies :: DDescription -> [SomeDocDefinitionItem] # docItemsOrder :: [DDescription] -> [DDescription] #
type DocItemPlacement DDescription
Instance details Defined in Michelson.Doc type DocItemPlacement DDescription = 'DocItemInlined
type DocItemPosition DDescription
Instance details Defined in Michelson.Doc type DocItemPosition DDescription = 10

data DGitRevision #

Constructors

DGitRevisionKnown DGitRevisionInfo
DGitRevisionUnknown

Instances

Instances details

DocItem DGitRevision
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DGitRevision = (pos :: Nat) # type DocItemPlacement DGitRevision :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DGitRevision -> DocItemRef (DocItemPlacement DGitRevision) # docItemToMarkdown :: HeaderLevel -> DGitRevision -> Markdown # docItemDependencies :: DGitRevision -> [SomeDocDefinitionItem] # docItemsOrder :: [DGitRevision] -> [DGitRevision] #
type DocItemPlacement DGitRevision
Instance details Defined in Michelson.Doc type DocItemPlacement DGitRevision = 'DocItemInlined
type DocItemPosition DGitRevision
Instance details Defined in Michelson.Doc type DocItemPosition DGitRevision = 2

newtype GitRepoSettings #

Repository settings for DGitRevision.

Constructors

GitRepoSettings
Fields grsMkGitRevision :: Text -> Text By commit sha make up a url to that commit in remote repository.

mkDGitRevision :: ExpQ #

Make DGitRevision.

>>> :t $mkDGitRevision
GitRepoSettings -> DGitRevision

morleyRepoSettings :: GitRepoSettings #

data DComment #

Comment in the doc (mostly used for licenses)

Constructors

DComment Text

Instances

Instances details

DocItem DComment
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DComment = (pos :: Nat) # type DocItemPlacement DComment :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DComment -> DocItemRef (DocItemPlacement DComment) # docItemToMarkdown :: HeaderLevel -> DComment -> Markdown # docItemDependencies :: DComment -> [SomeDocDefinitionItem] # docItemsOrder :: [DComment] -> [DComment] #
type DocItemPlacement DComment
Instance details Defined in Michelson.Doc type DocItemPlacement DComment = 'DocItemInlined
type DocItemPosition DComment
Instance details Defined in Michelson.Doc type DocItemPosition DComment = 0

data DAnchor #

A hand-made anchor.

Constructors

DAnchor Anchor

Instances

Instances details

DocItem DAnchor
Instance details Defined in Michelson.Doc Associated Types type DocItemPosition DAnchor = (pos :: Nat) # type DocItemPlacement DAnchor :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DAnchor -> DocItemRef (DocItemPlacement DAnchor) # docItemToMarkdown :: HeaderLevel -> DAnchor -> Markdown # docItemDependencies :: DAnchor -> [SomeDocDefinitionItem] # docItemsOrder :: [DAnchor] -> [DAnchor] #
type DocItemPlacement DAnchor
Instance details Defined in Michelson.Doc type DocItemPlacement DAnchor = 'DocItemInlined
type DocItemPosition DAnchor
Instance details Defined in Michelson.Doc type DocItemPosition DAnchor = 4

data DType where #

Doc element with description of a type.

Constructors

DType :: forall a. TypeHasDoc a => Proxy a -> DType

Instances

Instances details

Eq DType
Instance details Defined in Michelson.Typed.Haskell.Doc Methods (==) :: DType -> DType -> Bool # (/=) :: DType -> DType -> Bool #
Ord DType
Instance details Defined in Michelson.Typed.Haskell.Doc Methods compare :: DType -> DType -> Ordering # (<) :: DType -> DType -> Bool # (<=) :: DType -> DType -> Bool # (>) :: DType -> DType -> Bool # (>=) :: DType -> DType -> Bool # max :: DType -> DType -> DType # min :: DType -> DType -> DType #
Show DType
Instance details Defined in Michelson.Typed.Haskell.Doc Methods showsPrec :: Int -> DType -> ShowS # show :: DType -> String # showList :: [DType] -> ShowS #
DocItem DType
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPosition DType = (pos :: Nat) # type DocItemPlacement DType :: DocItemPlacementKind # Methods docItemSectionName :: Maybe Text # docItemSectionDescription :: Maybe Markdown # docItemSectionNameStyle :: DocSectionNameStyle # docItemRef :: DType -> DocItemRef (DocItemPlacement DType) # docItemToMarkdown :: HeaderLevel -> DType -> Markdown # docItemDependencies :: DType -> [SomeDocDefinitionItem] # docItemsOrder :: [DType] -> [DType] #
type DocItemPlacement DType
Instance details Defined in Michelson.Typed.Haskell.Doc type DocItemPlacement DType = 'DocItemInDefinitions
type DocItemPosition DType
Instance details Defined in Michelson.Typed.Haskell.Doc type DocItemPosition DType = 5000

dTypeDep :: TypeHasDoc t => SomeDocDefinitionItem #

Create a DType in form suitable for putting to typeDocDependencies.

docDefinitionRef :: (DocItem d, DocItemPlacement d ~ 'DocItemInDefinitions) => Markdown -> d -> Markdown #

Make a reference to doc item in definitions.

contractDocToMarkdown :: ContractDoc -> LText #

Render given contract documentation to markdown document.

subDocToMarkdown :: HeaderLevel -> SubDoc -> Markdown #

Render documentation for SubDoc.

class (Typeable a, SingI (TypeDocFieldDescriptions a), FieldDescriptionsValid (TypeDocFieldDescriptions a) a) => TypeHasDoc a where #

Description for a Haskell type appearing in documentation.

Minimal complete definition

typeDocMdDescription

Associated Types

type TypeDocFieldDescriptions a :: FieldDescriptions #

Description of constructors and fields of a.

See FieldDescriptions documentation for an example of usage.

Descriptions will be checked at compile time to make sure that only existing constructors and fields are referenced.

For that check to work instance Generic a is required whenever TypeDocFieldDescriptions is not empty.

For implementation of the check see FieldDescriptionsValid type family.

type TypeDocFieldDescriptions a = '[] :: [(Symbol, (Maybe Symbol, [(Symbol, Symbol)]))] #

Methods

typeDocName :: Proxy a -> Text #

Name of type as it appears in definitions section.

Each type must have its own unique name because it will be used in identifier for references.

Default definition derives name from Generics. If it does not fit, consider defining this function manually. (We tried using Data for this, but it produces names including module names which is not do we want).

typeDocMdDescription :: Markdown #

Explanation of a type. Markdown formatting is allowed.

typeDocMdReference :: Proxy a -> WithinParens -> Markdown #

How reference to this type is rendered, in Markdown.

Examples:

[Integer](#type-integer),
[Maybe](#type-Maybe) [()](#type-unit).

Consider using one of the following functions as default implementation; which one to use depends on number of type arguments in your type:

If none of them fits your purposes precisely, consider using customTypeDocMdReference.

typeDocDependencies :: Proxy a -> [SomeDocDefinitionItem] #

All types which this type directly contains.

Used in automatic types discovery.

typeDocHaskellRep :: TypeDocHaskellRep a #

For complex types - their immediate Haskell representation.

For primitive types set this to Nothing.

For homomorphic types use homomorphicTypeDocHaskellRep implementation.

For polymorhpic types consider using concreteTypeDocHaskellRep as implementation.

Modifier haskellRepNoFields can be used to hide names of fields, beneficial for newtypes.

Another modifier called haskellRepStripFieldPrefix can be used for datatypes to leave only meaningful part of name in every field.

typeDocMichelsonRep :: TypeDocMichelsonRep a #

Final michelson representation of a type.

For homomorphic types use homomorphicTypeDocMichelsonRep implementation.

For polymorhpic types consider using concreteTypeDocMichelsonRep as implementation.

Instances

Instances details

TypeHasDoc Bool
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Bool :: FieldDescriptions # Methods typeDocName :: Proxy Bool -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Bool -> WithinParens -> Markdown # typeDocDependencies :: Proxy Bool -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Bool # typeDocMichelsonRep :: TypeDocMichelsonRep Bool #
TypeHasDoc Integer
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Integer :: FieldDescriptions # Methods typeDocName :: Proxy Integer -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Integer -> WithinParens -> Markdown # typeDocDependencies :: Proxy Integer -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Integer # typeDocMichelsonRep :: TypeDocMichelsonRep Integer #
TypeHasDoc Natural
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Natural :: FieldDescriptions # Methods typeDocName :: Proxy Natural -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Natural -> WithinParens -> Markdown # typeDocDependencies :: Proxy Natural -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Natural # typeDocMichelsonRep :: TypeDocMichelsonRep Natural #
TypeHasDoc ()
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions () :: FieldDescriptions # Methods typeDocName :: Proxy () -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy () -> WithinParens -> Markdown # typeDocDependencies :: Proxy () -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep () # typeDocMichelsonRep :: TypeDocMichelsonRep () #
TypeHasDoc ByteString
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions ByteString :: FieldDescriptions # Methods typeDocName :: Proxy ByteString -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy ByteString -> WithinParens -> Markdown # typeDocDependencies :: Proxy ByteString -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep ByteString # typeDocMichelsonRep :: TypeDocMichelsonRep ByteString #
TypeHasDoc Operation
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Operation :: FieldDescriptions # Methods typeDocName :: Proxy Operation -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Operation -> WithinParens -> Markdown # typeDocDependencies :: Proxy Operation -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Operation # typeDocMichelsonRep :: TypeDocMichelsonRep Operation #
TypeHasDoc EpAddress
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions EpAddress :: FieldDescriptions # Methods typeDocName :: Proxy EpAddress -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy EpAddress -> WithinParens -> Markdown # typeDocDependencies :: Proxy EpAddress -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep EpAddress # typeDocMichelsonRep :: TypeDocMichelsonRep EpAddress #
TypeHasDoc Address
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Address :: FieldDescriptions # Methods typeDocName :: Proxy Address -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Address -> WithinParens -> Markdown # typeDocDependencies :: Proxy Address -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Address # typeDocMichelsonRep :: TypeDocMichelsonRep Address #
TypeHasDoc Mutez
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Mutez :: FieldDescriptions # Methods typeDocName :: Proxy Mutez -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Mutez -> WithinParens -> Markdown # typeDocDependencies :: Proxy Mutez -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Mutez # typeDocMichelsonRep :: TypeDocMichelsonRep Mutez #
TypeHasDoc Timestamp
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Timestamp :: FieldDescriptions # Methods typeDocName :: Proxy Timestamp -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Timestamp -> WithinParens -> Markdown # typeDocDependencies :: Proxy Timestamp -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Timestamp # typeDocMichelsonRep :: TypeDocMichelsonRep Timestamp #
TypeHasDoc PublicKey
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions PublicKey :: FieldDescriptions # Methods typeDocName :: Proxy PublicKey -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy PublicKey -> WithinParens -> Markdown # typeDocDependencies :: Proxy PublicKey -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep PublicKey # typeDocMichelsonRep :: TypeDocMichelsonRep PublicKey #
TypeHasDoc Signature
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions Signature :: FieldDescriptions # Methods typeDocName :: Proxy Signature -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Signature -> WithinParens -> Markdown # typeDocDependencies :: Proxy Signature -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Signature # typeDocMichelsonRep :: TypeDocMichelsonRep Signature #
TypeHasDoc KeyHash
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions KeyHash :: FieldDescriptions # Methods typeDocName :: Proxy KeyHash -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy KeyHash -> WithinParens -> Markdown # typeDocDependencies :: Proxy KeyHash -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep KeyHash # typeDocMichelsonRep :: TypeDocMichelsonRep KeyHash #
TypeHasDoc MText
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions MText :: FieldDescriptions # Methods typeDocName :: Proxy MText -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy MText -> WithinParens -> Markdown # typeDocDependencies :: Proxy MText -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep MText # typeDocMichelsonRep :: TypeDocMichelsonRep MText #
TypeHasDoc Empty Source #
Instance details Defined in Lorentz.Empty Associated Types type TypeDocFieldDescriptions Empty :: FieldDescriptions # Methods typeDocName :: Proxy Empty -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy Empty -> WithinParens -> Markdown # typeDocDependencies :: Proxy Empty -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep Empty # typeDocMichelsonRep :: TypeDocMichelsonRep Empty #
PolyTypeHasDocC '[a] => TypeHasDoc [a]
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions [a] :: FieldDescriptions # Methods typeDocName :: Proxy [a] -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy [a] -> WithinParens -> Markdown # typeDocDependencies :: Proxy [a] -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep [a] # typeDocMichelsonRep :: TypeDocMichelsonRep [a] #
PolyTypeHasDocC '[a] => TypeHasDoc (Maybe a)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Maybe a) :: FieldDescriptions # Methods typeDocName :: Proxy (Maybe a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Maybe a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Maybe a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Maybe a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Maybe a) #
PolyCTypeHasDocC '[a] => TypeHasDoc (Set a)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Set a) :: FieldDescriptions # Methods typeDocName :: Proxy (Set a) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Set a) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Set a) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Set a) # typeDocMichelsonRep :: TypeDocMichelsonRep (Set a) #
PolyTypeHasDocC '[cp] => TypeHasDoc (ContractRef cp)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (ContractRef cp) :: FieldDescriptions # Methods typeDocName :: Proxy (ContractRef cp) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (ContractRef cp) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (ContractRef cp) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (ContractRef cp) # typeDocMichelsonRep :: TypeDocMichelsonRep (ContractRef cp) #
UStoreTemplateHasDoc template => TypeHasDoc (UStore template) Source #
Instance details Defined in Lorentz.UStore.Doc Associated Types type TypeDocFieldDescriptions (UStore template) :: FieldDescriptions # Methods typeDocName :: Proxy (UStore template) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (UStore template) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (UStore template) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (UStore template) # typeDocMichelsonRep :: TypeDocMichelsonRep (UStore template) #
(TypeHasDoc r, IsError (VoidResult r)) => TypeHasDoc (VoidResult r) Source #
Instance details Defined in Lorentz.Macro Associated Types type TypeDocFieldDescriptions (VoidResult r) :: FieldDescriptions # Methods typeDocName :: Proxy (VoidResult r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (VoidResult r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (VoidResult r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (VoidResult r) # typeDocMichelsonRep :: TypeDocMichelsonRep (VoidResult r) #
Typeable interface => TypeHasDoc (UParam interface) Source #
Instance details Defined in Lorentz.UParam Associated Types type TypeDocFieldDescriptions (UParam interface) :: FieldDescriptions # Methods typeDocName :: Proxy (UParam interface) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (UParam interface) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (UParam interface) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (UParam interface) # typeDocMichelsonRep :: TypeDocMichelsonRep (UParam interface) #
PolyTypeHasDocC '[l, r] => TypeHasDoc (Either l r)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Either l r) :: FieldDescriptions # Methods typeDocName :: Proxy (Either l r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Either l r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Either l r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Either l r) # typeDocMichelsonRep :: TypeDocMichelsonRep (Either l r) #
PolyTypeHasDocC '[a, b] => TypeHasDoc (a, b)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b) #
(PolyCTypeHasDocC '[k], PolyTypeHasDocC '[v], Ord k) => TypeHasDoc (Map k v)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (Map k v) :: FieldDescriptions # Methods typeDocName :: Proxy (Map k v) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Map k v) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Map k v) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Map k v) # typeDocMichelsonRep :: TypeDocMichelsonRep (Map k v) #
(PolyCTypeHasDocC '[k], PolyTypeHasDocC '[v], Ord k) => TypeHasDoc (BigMap k v)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (BigMap k v) :: FieldDescriptions # Methods typeDocName :: Proxy (BigMap k v) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (BigMap k v) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (BigMap k v) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (BigMap k v) # typeDocMichelsonRep :: TypeDocMichelsonRep (BigMap k v) #
Each '[Typeable :: [Type] -> Constraint, ReifyList TypeHasDoc] '[i, o] => TypeHasDoc (i :-> o) Source #
Instance details Defined in Lorentz.Doc Associated Types type TypeDocFieldDescriptions (i :-> o) :: FieldDescriptions # Methods typeDocName :: Proxy (i :-> o) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (i :-> o) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (i :-> o) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (i :-> o) # typeDocMichelsonRep :: TypeDocMichelsonRep (i :-> o) #
Each '[Typeable :: Type -> Constraint, UStoreTemplateHasDoc] '[oldStore, newStore] => TypeHasDoc (MigrationScript oldStore newStore) Source #
Instance details Defined in Lorentz.UStore.Migration.Base Associated Types type TypeDocFieldDescriptions (MigrationScript oldStore newStore) :: FieldDescriptions # Methods typeDocName :: Proxy (MigrationScript oldStore newStore) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (MigrationScript oldStore newStore) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (MigrationScript oldStore newStore) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (MigrationScript oldStore newStore) # typeDocMichelsonRep :: TypeDocMichelsonRep (MigrationScript oldStore newStore) #
Each '[Typeable :: Type -> Constraint, TypeHasDoc] '[a, r] => TypeHasDoc (Void_ a r) Source #
Instance details Defined in Lorentz.Macro Associated Types type TypeDocFieldDescriptions (Void_ a r) :: FieldDescriptions # Methods typeDocName :: Proxy (Void_ a r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Void_ a r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Void_ a r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Void_ a r) # typeDocMichelsonRep :: TypeDocMichelsonRep (Void_ a r) #
Each '[Typeable :: Type -> Constraint, TypeHasDoc] '[a, r] => TypeHasDoc (View a r) Source #
Instance details Defined in Lorentz.Macro Associated Types type TypeDocFieldDescriptions (View a r) :: FieldDescriptions # Methods typeDocName :: Proxy (View a r) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (View a r) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (View a r) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (View a r) # typeDocMichelsonRep :: TypeDocMichelsonRep (View a r) #
(ExtensibleHasDoc x, ReifyList DocumentCtor (EnumerateCtors (GetCtors x))) => TypeHasDoc (Extensible x) Source #
Instance details Defined in Lorentz.Extensible Associated Types type TypeDocFieldDescriptions (Extensible x) :: FieldDescriptions # Methods typeDocName :: Proxy (Extensible x) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (Extensible x) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (Extensible x) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (Extensible x) # typeDocMichelsonRep :: TypeDocMichelsonRep (Extensible x) #
PolyTypeHasDocC '[a, b, c] => TypeHasDoc (a, b, c)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c) #
(TypeHasDoc (ApplyNamedFunctor f a), KnownSymbol n, SingI (ToT (ApplyNamedFunctor f Integer)), Typeable f, Typeable a) => TypeHasDoc (NamedF f a n)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (NamedF f a n) :: FieldDescriptions # Methods typeDocName :: Proxy (NamedF f a n) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (NamedF f a n) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (NamedF f a n) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (NamedF f a n) # typeDocMichelsonRep :: TypeDocMichelsonRep (NamedF f a n) #
PolyTypeHasDocC '[a, b, c, d] => TypeHasDoc (a, b, c, d)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d) #
PolyTypeHasDocC '[a, b, c, d, e] => TypeHasDoc (a, b, c, d, e)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d, e) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d, e) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d, e) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d, e) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d, e) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d, e) #
PolyTypeHasDocC '[a, b, c, d, e, f] => TypeHasDoc (a, b, c, d, e, f)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d, e, f) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d, e, f) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d, e, f) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d, e, f) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d, e, f) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d, e, f) #
PolyTypeHasDocC '[a, b, c, d, e, f, g] => TypeHasDoc (a, b, c, d, e, f, g)
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type TypeDocFieldDescriptions (a, b, c, d, e, f, g) :: FieldDescriptions # Methods typeDocName :: Proxy (a, b, c, d, e, f, g) -> Text # typeDocMdDescription :: Markdown # typeDocMdReference :: Proxy (a, b, c, d, e, f, g) -> WithinParens -> Markdown # typeDocDependencies :: Proxy (a, b, c, d, e, f, g) -> [SomeDocDefinitionItem] # typeDocHaskellRep :: TypeDocHaskellRep (a, b, c, d, e, f, g) # typeDocMichelsonRep :: TypeDocMichelsonRep (a, b, c, d, e, f, g) #

data SomeTypeWithDoc where #

Data hides some type implementing TypeHasDoc.

Constructors

SomeTypeWithDoc :: forall td. TypeHasDoc td => Proxy td -> SomeTypeWithDoc

class HaveCommonTypeCtor (a :: k) (b :: k1) #

Require two types to be built from the same type constructor.

E.g. HaveCommonTypeCtor (Maybe Integer) (Maybe Natural) is defined, while HaveCmmonTypeCtor (Maybe Integer) [Integer] is not.

Instances

Instances details

HaveCommonTypeCtor (a :: k) (a :: k)
Instance details Defined in Michelson.Typed.Haskell.Doc
HaveCommonTypeCtor ac bc => HaveCommonTypeCtor (ac a :: k2) (bc b :: k4)
Instance details Defined in Michelson.Typed.Haskell.Doc

class IsHomomorphic (a :: k) #

Require this type to be homomorphic.

Instances

Instances details

IsHomomorphic (a :: k)
Instance details Defined in Michelson.Typed.Haskell.Doc
(TypeError ('Text "Type is not homomorphic: " :<>: 'ShowType (a b)) :: Constraint) => IsHomomorphic (a b :: k2)
Instance details Defined in Michelson.Typed.Haskell.Doc

genericTypeDocDependencies :: (Generic a, GTypeHasDoc (Rep a)) => Proxy a -> [SomeDocDefinitionItem] #

Implement typeDocDependencies via getting all immediate fields of a datatype.

Note: this will not include phantom types, I'm not sure yet how this scenario should be handled (@martoon).

customTypeDocMdReference :: (Text, DType) -> [DType] -> WithinParens -> Markdown #

Render a reference to a type which consists of type constructor (you have to provide name of this type constructor and documentation for the whole type) and zero or more type arguments.

homomorphicTypeDocMdReference :: (Typeable t, TypeHasDoc t, IsHomomorphic t) => Proxy t -> WithinParens -> Markdown #

Derive typeDocMdReference, for homomorphic types only.

poly1TypeDocMdReference :: forall (t :: Type -> Type) r a. (r ~ t a, Typeable t, Each '[TypeHasDoc] '[r, a], IsHomomorphic t) => Proxy r -> WithinParens -> Markdown #

Derive typeDocMdReference, for polymorphic type with one type argument, like Maybe Integer.

poly2TypeDocMdReference :: forall (t :: Type -> Type -> Type) r a b. (r ~ t a b, Typeable t, Each '[TypeHasDoc] '[r, a, b], IsHomomorphic t) => Proxy r -> WithinParens -> Markdown #

Derive typeDocMdReference, for polymorphic type with two type arguments, like Lambda Integer Natural.

homomorphicTypeDocHaskellRep :: (Generic a, GTypeHasDoc (Rep a)) => TypeDocHaskellRep a #

Implement typeDocHaskellRep for a homomorphic type.

Note that it does not require your type to be of IsHomomorphic instance, which can be useful for some polymorhpic types which, for documentation purposes, we want to consider homomorphic.

Example: Operation is in fact polymorhpic, but we don't want this fact to be reflected in the documentation.

concreteTypeDocHaskellRep :: (Typeable a, GenericIsoValue a, GTypeHasDoc (Rep a), HaveCommonTypeCtor b a) => TypeDocHaskellRep b #

Implement typeDocHaskellRep on example of given concrete type.

This is a best effort attempt to implement typeDocHaskellRep for polymorhpic types, as soon as there is no simple way to preserve type variables when automatically deriving Haskell representation of a type.

concreteTypeDocHaskellRepUnsafe :: (Typeable a, GenericIsoValue a, GTypeHasDoc (Rep a)) => TypeDocHaskellRep b #

Version of concreteTypeDocHaskellRep which does not ensure whether the type for which representation is built is any similar to the original type which you implement a TypeHasDoc instance for.

haskellRepNoFields :: TypeDocHaskellRep a -> TypeDocHaskellRep a #

Erase fields from Haskell datatype representation.

Use this when rendering fields names is undesired.

haskellRepStripFieldPrefix :: HasCallStack => TypeDocHaskellRep a -> TypeDocHaskellRep a #

Cut fields prefixes which we use according to the style guide.

E.g. cmMyField field will be transformed to myField.

homomorphicTypeDocMichelsonRep :: SingI (ToT a) => TypeDocMichelsonRep a #

Implement typeDocMichelsonRep for homomorphic type.

concreteTypeDocMichelsonRep :: forall k a (b :: k). (Typeable a, SingI (ToT a), HaveCommonTypeCtor b a) => TypeDocMichelsonRep b #

Implement typeDocMichelsonRep on example of given concrete type.

This function exists for the same reason as concreteTypeDocHaskellRep.

concreteTypeDocMichelsonRepUnsafe :: forall k a (b :: k). (Typeable a, SingI (ToT a)) => TypeDocMichelsonRep b #

Version of concreteTypeDocHaskellRepUnsafe which does not ensure whether the type for which representation is built is any similar to the original type which you implement a TypeHasDoc instance for.

Orphan instances

Each '[Typeable :: [Type] -> Constraint, ReifyList TypeHasDoc] '[i, o] => TypeHasDoc (i :-> o) Source #

Instance details

Associated Types

type TypeDocFieldDescriptions (i :-> o) :: FieldDescriptions #

Methods

typeDocName :: Proxy (i :-> o) -> Text #

typeDocMdDescription :: Markdown #

typeDocMdReference :: Proxy (i :-> o) -> WithinParens -> Markdown #

typeDocDependencies :: Proxy (i :-> o) -> [SomeDocDefinitionItem] #

typeDocHaskellRep :: TypeDocHaskellRep (i :-> o) #

typeDocMichelsonRep :: TypeDocMichelsonRep (i :-> o) #