Modulehslua-packaging-2.4.1Haskell2010

HsLua.Packaging.Types

Marshaling and documenting Haskell functions.

Contents

Documented Lua objects
Documentation types
Type classes

Synopsis

data Module
data Field
data DocumentedFunction
type DocumentedType
data DocumentationObject
data ModuleDoc
data FunctionDoc
data TypeDoc
data ParameterDoc
data ResultsDoc
data ResultValueDoc
data FieldDoc
class HasName
class HasDescription

Packagehslua-packaging-2.4.1
Exports14
LanguageHaskell2010
LicenceMIT
SourceTypes.hs

Documented Lua objects

datadata Module e

Source#

Named and documented Lua module.

Constructors

Module
- moduleName :: Name
- moduleDescription :: Text
- moduleFields :: [Field e]
- moduleFunctions :: [DocumentedFunction e]
- moduleOperations :: [(Operation, DocumentedFunction e)]
- moduleTypeInitializers :: [LuaE e Name]
  Lua initializers for the types that come with this module. Useful to force full initialization of all metatables.
- moduleTypeDocs :: [TypeDoc]
  Documentation for the types that are associated with this module.

Instances2HasDescription, HasName

HasDescription (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata Field e

Source#

Self-documenting module field

Constructors

Field
- fieldName :: Name
- fieldDoc :: FieldDoc
- fieldPushValue :: LuaE e ()

Instances2HasDescription, HasName

HasDescription (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata DocumentedFunction e

Source#

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

Constructors

DocumentedFunction
- callFunction :: LuaE e NumResults
- functionName :: Name
- functionDoc :: FunctionDoc

Instances1HasName

HasName (DocumentedFunction e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

typetype DocumentedType e a = UDType e (DocumentedFunction e) a

Source#

Type definitions containing documented functions.

Documentation types

datadata DocumentationObject

Source#

Documentation for any of the supported Lua objects.

Instances3Eq, Ord, Show

Eq DocumentationObjectDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord DocumentationObjectDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show DocumentationObjectDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata ModuleDoc

Source#

Module documentation

Constructors

ModuleDoc
- moduleDocName :: Text
  module name
- moduleDocDescription :: Text
  textual module description
- moduleDocFields :: [FieldDoc]
  module fields
- moduleDocFunctions :: [FunctionDoc]
  module functions
- moduleDocTypes :: [TypeDoc]
  module-associated types

Instances4Eq, Ord, Show, HasDescription

Eq ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata FunctionDoc

Source#

Documentation for a Haskell function

Constructors

FunDoc
- funDocName :: Text
- funDocDescription :: Text
- funDocParameters :: [ParameterDoc]
- funDocResults :: ResultsDoc
- funDocSince :: Maybe Version
  Version in which the function was introduced.

Instances3Eq, Ord, Show

Eq FunctionDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord FunctionDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show FunctionDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata TypeDoc

Source#

Documentation of a data type.

Constructors

TypeDoc
- typeDocName :: Text
- typeDocDescription :: Text
- typeDocOperations :: [(Operation, FunctionDoc)]
- typeDocMethods :: [FunctionDoc]

Instances3Eq, Ord, Show

Eq TypeDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord TypeDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show TypeDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata ParameterDoc

Source#

Documentation for function parameters.

Constructors

ParameterDoc
- parameterName :: Text
- parameterType :: TypeSpec
- parameterDescription :: Text
- parameterIsOptional :: Bool

Instances3Eq, Ord, Show

Eq ParameterDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord ParameterDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show ParameterDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata ResultsDoc

Source#

Documentation for the return values of a function.

Constructors

ResultsDocList [ResultValueDoc]
List of individual results
ResultsDocMult Text
Flexible results

Instances3Eq, Ord, Show

Eq ResultsDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord ResultsDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show ResultsDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata ResultValueDoc

Source#

Documentation for a single return value of a function.

Constructors

ResultValueDoc
- resultValueType :: TypeSpec
- resultValueDescription :: Text

Instances3Eq, Ord, Show

Eq ResultValueDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord ResultValueDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show ResultValueDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

datadata FieldDoc

Source#

Documentation for a module field.

Constructors

FieldDoc
- fieldDocName :: Text
- fieldDocType :: TypeSpec
- fieldDocDescription :: Text

Instances4Eq, Ord, Show, HasDescription

Eq FieldDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Ord FieldDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
Show FieldDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription FieldDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

Type classes

classclass HasName a where

Source#

Named objects

Methods

getName :: a -> Name
setName :: a -> Name -> a

Instances3HasName

HasName (DocumentedFunction e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasName (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types

classclass HasDescription a where

Source#

Objects that have descriptions.

Methods

getDescription :: a -> Text
setDescription :: a -> Text -> a

Instances4HasDescription

HasDescription FieldDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription ModuleDocDefined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription (Field e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types
HasDescription (Module e)Defined in hslua-packaging-2.4.1 · HsLua.Packaging.Types