hslua-packaging-2.3.1: Utilities to build Lua modules.
Copyright© 2020-2024 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@hslua.org>
Stabilityalpha
PortabilityPortable
Safe HaskellNone
LanguageHaskell2010

HsLua.Packaging.Types

Description

Marshaling and documenting Haskell functions.

Synopsis

Documented module

data Module e Source #

Named and documented Lua module.

data Field e Source #

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

Instances details
Show FunctionDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> FunctionDoc -> ShowS

show :: FunctionDoc -> String

showList :: [FunctionDoc] -> ShowS

Eq FunctionDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

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

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

Ord FunctionDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

data ParameterDoc Source #

Documentation for function parameters.

Constructors

ParameterDoc 

Fields

Instances

Instances details
Show ParameterDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ParameterDoc -> ShowS

show :: ParameterDoc -> String

showList :: [ParameterDoc] -> ShowS

Eq ParameterDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

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

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

Ord ParameterDoc Source # 
Instance details

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

Instances details
Show ResultsDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ResultsDoc -> ShowS

show :: ResultsDoc -> String

showList :: [ResultsDoc] -> ShowS

Eq ResultsDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

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

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

Ord ResultsDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

data ResultValueDoc Source #

Documentation for a single return value of a function.

Constructors

ResultValueDoc 

Fields

Instances

Instances details
Show ResultValueDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Methods

showsPrec :: Int -> ResultValueDoc -> ShowS

show :: ResultValueDoc -> String

showList :: [ResultValueDoc] -> ShowS

Eq ResultValueDoc Source # 
Instance details

Defined in HsLua.Packaging.Types

Ord ResultValueDoc Source # 
Instance details

Defined in HsLua.Packaging.Types