Documentation

Gathers information about single entrypoint.

We assume that entry points might be of different kinds, which is designated by phantom type parameter. For instance, you may want to have several groups of entry points corresponding to various parts of a contract - specifying different kind type argument for each of those groups will allow you defining different DocItem instances with appropriate custom descriptions for them.

Provides arror for convenient entrypoint documentation

Default value for DEntrypoint type argument.

Default implementation of docItemToMarkdown for entry points.

Describes argument of an entrypoint.

Pick a type documentation from CtorField.

When describing the way of parameter construction - piece of incremental builder for this description.

Describes a parameter building step.

This can be wrapping into (Haskell) constructor, or a more complex transformation.

Make a ParamBuildingStep that tells about wrapping an argument into a constructor with given name and uses given ParamBuilder as description of Michelson part.

Go over contract code and update every occurrence of DEntrypointArg documentation item, adding the given step to its "how to build parameter" description.

Constraint for documentEntrypoints.

Wrapper for documenting single entrypoint which parameter isn't going to be unwrapped from some datatype.

entryCase unwraps a datatype, however, sometimes we want to have entrypoint parameter to be not wrapped into some datatype.

Version of entryCase_ for tuples.

Like case_, to be used for pattern-matching on a parameter or its part.

Modifies documentation accordingly. Including description of entrypoints' arguments, thus for them you will need to supply TypeHasDoc instance.

Modify param building steps with respect to entrypoints that given parameter declares.

Each contract with entrypoints should eventually call this function, otherwise, in case if contract uses built-in entrypoints feature, the resulting parameter building steps in the generated documentation will not consider entrypoints and thus may be incorrect.

Calling this twice over the same code is also prohibited.

Whether finalizeParamCallingDoc has already been applied to these steps.

Version of entryCase for contracts with flat parameter, use it when you need only one entryCase all over the contract implementation.

This method calls finalizeParamCallingDoc inside.