Copyright | © 2020-2022 Albert Krewinkel |
---|---|
License | MIT |
Maintainer | Albert Krewinkel <tarleb+hslua@zeitkraut.de> |
Stability | alpha |
Portability | Portable |
Safe Haskell | None |
Language | Haskell2010 |
HsLua.Packaging.Types
Description
Marshaling and documenting Haskell functions.
Synopsis
- data Module e = Module {
- moduleName :: Name
- moduleDescription :: Text
- moduleFields :: [Field e]
- moduleFunctions :: [DocumentedFunction e]
- moduleOperations :: [(Operation, DocumentedFunction e)]
- data Field e = Field {
- fieldName :: Text
- fieldDescription :: Text
- fieldPushValue :: LuaE e ()
- data DocumentedFunction e = DocumentedFunction {}
- data FunctionDoc = FunctionDoc {}
- data ParameterDoc = ParameterDoc {}
- data ResultsDoc
- data ResultValueDoc = ResultValueDoc {}
Documented module
Named and documented Lua module.
Constructors
Module | |
Fields
|
Self-documenting module field
Constructors
Field | |
Fields
|
Documented functions
data DocumentedFunction e Source #
Haskell equivallent to CFunction, i.e., function callable from Lua.
Constructors
DocumentedFunction | |
Fields
|
Documentation types
data FunctionDoc Source #
Documentation for a Haskell function
Constructors
FunctionDoc | |
Fields
|
Instances
Eq FunctionDoc Source # | |
Defined in HsLua.Packaging.Types Methods (==) :: FunctionDoc -> FunctionDoc -> Bool Source # (/=) :: FunctionDoc -> FunctionDoc -> Bool Source # | |
Ord FunctionDoc Source # | |
Defined in HsLua.Packaging.Types Methods compare :: FunctionDoc -> FunctionDoc -> Ordering Source # (<) :: FunctionDoc -> FunctionDoc -> Bool Source # (<=) :: FunctionDoc -> FunctionDoc -> Bool Source # (>) :: FunctionDoc -> FunctionDoc -> Bool Source # (>=) :: FunctionDoc -> FunctionDoc -> Bool Source # max :: FunctionDoc -> FunctionDoc -> FunctionDoc Source # min :: FunctionDoc -> FunctionDoc -> FunctionDoc Source # | |
Show FunctionDoc Source # | |
Defined in HsLua.Packaging.Types |
data ParameterDoc Source #
Documentation for function parameters.
Constructors
ParameterDoc | |
Fields |
Instances
Eq ParameterDoc Source # | |
Defined in HsLua.Packaging.Types Methods (==) :: ParameterDoc -> ParameterDoc -> Bool Source # (/=) :: ParameterDoc -> ParameterDoc -> Bool Source # | |
Ord ParameterDoc Source # | |
Defined in HsLua.Packaging.Types Methods compare :: ParameterDoc -> ParameterDoc -> Ordering Source # (<) :: ParameterDoc -> ParameterDoc -> Bool Source # (<=) :: ParameterDoc -> ParameterDoc -> Bool Source # (>) :: ParameterDoc -> ParameterDoc -> Bool Source # (>=) :: ParameterDoc -> ParameterDoc -> Bool Source # max :: ParameterDoc -> ParameterDoc -> ParameterDoc Source # min :: ParameterDoc -> ParameterDoc -> ParameterDoc Source # | |
Show ParameterDoc Source # | |
Defined in HsLua.Packaging.Types |
data ResultsDoc Source #
Documentation for the return values of a function.
Constructors
ResultsDocList [ResultValueDoc] | List of individual results |
ResultsDocMult Text | Flexible results |
Instances
Eq ResultsDoc Source # | |
Defined in HsLua.Packaging.Types Methods (==) :: ResultsDoc -> ResultsDoc -> Bool Source # (/=) :: ResultsDoc -> ResultsDoc -> Bool Source # | |
Ord ResultsDoc Source # | |
Defined in HsLua.Packaging.Types Methods compare :: ResultsDoc -> ResultsDoc -> Ordering Source # (<) :: ResultsDoc -> ResultsDoc -> Bool Source # (<=) :: ResultsDoc -> ResultsDoc -> Bool Source # (>) :: ResultsDoc -> ResultsDoc -> Bool Source # (>=) :: ResultsDoc -> ResultsDoc -> Bool Source # max :: ResultsDoc -> ResultsDoc -> ResultsDoc Source # min :: ResultsDoc -> ResultsDoc -> ResultsDoc Source # | |
Show ResultsDoc Source # | |
Defined in HsLua.Packaging.Types |
data ResultValueDoc Source #
Documentation for a single return value of a function.
Constructors
ResultValueDoc | |
Fields |
Instances
Eq ResultValueDoc Source # | |
Defined in HsLua.Packaging.Types Methods (==) :: ResultValueDoc -> ResultValueDoc -> Bool Source # (/=) :: ResultValueDoc -> ResultValueDoc -> Bool Source # | |
Ord ResultValueDoc Source # | |
Defined in HsLua.Packaging.Types Methods compare :: ResultValueDoc -> ResultValueDoc -> Ordering Source # (<) :: ResultValueDoc -> ResultValueDoc -> Bool Source # (<=) :: ResultValueDoc -> ResultValueDoc -> Bool Source # (>) :: ResultValueDoc -> ResultValueDoc -> Bool Source # (>=) :: ResultValueDoc -> ResultValueDoc -> Bool Source # max :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc Source # min :: ResultValueDoc -> ResultValueDoc -> ResultValueDoc Source # | |
Show ResultValueDoc Source # | |
Defined in HsLua.Packaging.Types |