Pushes the documentation for the element at the given stack index. Returns the type of the documentation object.
Modulehslua-packaging-2.4.1Haskell2010
HsLua.Packaging.Documentation
Provides a function to print documentation if available.
Synopsis
- value getdocumentation
- value registerDocumentation
- value docsField
- data ModuleDoc
- data FunctionDoc
- data DocumentationObject
- value pushDocumentationObject
- value peekDocumentationObject
- value pushModuleDoc
- value peekModuleDoc
- value pushFunctionDoc
- value peekFunctionDoc
- value pushTypeDoc
- value peekTypeDoc
- value generateFunctionDocumentation
- value generateModuleDocumentation
- value generateTypeDocumentation
- Packagehslua-packaging-2.4.1
- Exports17
- LanguageHaskell2010
- LicenceMIT
- SourceDocumentation.hs
Setting and retrieving documentation
Registers the object at the top of the stack as documentation for
the object at index idx. Pops the documentation of the stack.
Name of the registry field holding the documentation table. The documentation table is indexed by the documented objects, like module tables and functions, and contains documentation objects as values.
The table is an ephemeron table, i.e., an entry gets garbage collected if the key is no longer reachable.
Documentation Types
Module documentation
Constructors
ModuleDocmoduleDocName :: Textmodule name
moduleDocDescription :: Texttextual module description
moduleDocFields :: [FieldDoc]module fields
moduleDocFunctions :: [FunctionDoc]module functions
moduleDocTypes :: [TypeDoc]module-associated types
Instances4Eq, Ord, Show, HasDescription
Documentation for a Haskell function
Constructors
FunDocfunDocName :: TextfunDocDescription :: TextfunDocParameters :: [ParameterDoc]funDocResults :: ResultsDocfunDocSince :: Maybe VersionVersion in which the function was introduced.
Instances3Eq, Ord, Show
Eq FunctionDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.TypesOrd FunctionDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.TypesShow FunctionDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Documentation for any of the supported Lua objects.
Instances3Eq, Ord, Show
Eq DocumentationObjectDefined in hslua-packaging-2.4.1 · HsLua.Packaging.TypesOrd DocumentationObjectDefined in hslua-packaging-2.4.1 · HsLua.Packaging.TypesShow DocumentationObjectDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Pushes a DocumentationObject to the Lua stack.
Pushes the metatable for documentation objects.
Pushes the documentation of a module as userdata.
Retrieves a module documentation object from the Lua stack.
Pushes function documentation as userdata.
Retrieve function documentation from the Lua stack.
Pushes documentation type documentation as userdata.
Retrieve function documentation from the Lua stack.
Creating documentation values
Generate FunctionDoc documentation for module functions.
Generate documentation for a module.
Generate documentation for a UDType.