hslua-packaging-2.3.0: Utilities to build Lua modules.
Copyright© 2020-2023 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@hslua.org>
Stabilityalpha
PortabilityPortable
Safe HaskellSafe-Inferred
LanguageHaskell2010

HsLua.Packaging.Types

Description

Marshaling and documenting Haskell functions.

Synopsis

Documented module

data Module e #

Named and documented Lua module.

data Field e #

Self-documenting module field

Constructors

Field 

Fields

Documented functions

data DocumentedFunction e #

Haskell equivallent to CFunction, i.e., function callable from Lua.

Documentation types

data FunctionDoc #

Documentation for a Haskell function

Constructors

FunctionDoc 

Fields

Instances

Instances details
Show FunctionDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> FunctionDoc -> ShowS

show :: FunctionDoc -> String

showList :: [FunctionDoc] -> ShowS

Eq FunctionDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

(==) :: FunctionDoc -> FunctionDoc -> Bool

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

Ord FunctionDoc # 
Instance details

Defined in HsLua.Packaging.Types

data ParameterDoc #

Documentation for function parameters.

Instances

Instances details
Show ParameterDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ParameterDoc -> ShowS

show :: ParameterDoc -> String

showList :: [ParameterDoc] -> ShowS

Eq ParameterDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

(==) :: ParameterDoc -> ParameterDoc -> Bool

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

Ord ParameterDoc # 
Instance details

Defined in HsLua.Packaging.Types

data ResultsDoc #

Documentation for the return values of a function.

Constructors

ResultsDocList [ResultValueDoc]

List of individual results

ResultsDocMult Text

Flexible results

Instances

Instances details
Show ResultsDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ResultsDoc -> ShowS

show :: ResultsDoc -> String

showList :: [ResultsDoc] -> ShowS

Eq ResultsDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

(==) :: ResultsDoc -> ResultsDoc -> Bool

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

Ord ResultsDoc # 
Instance details

Defined in HsLua.Packaging.Types

data ResultValueDoc #

Documentation for a single return value of a function.

Instances

Instances details
Show ResultValueDoc # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ResultValueDoc -> ShowS

show :: ResultValueDoc -> String

showList :: [ResultValueDoc] -> ShowS

Eq ResultValueDoc # 
Instance details

Defined in HsLua.Packaging.Types

Ord ResultValueDoc # 
Instance details

Defined in HsLua.Packaging.Types