OOLua  2.0.1
C++ and Lua binding
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
only_for_doxygen.h File Reference

This file is not part of OOLua, the only reason for it is to allow doxygen to document some things which otherwise it can not do. More...

Macros

#define OOLUA_NEW_POINTER_DEFAULT_IS_SHARED_TYPE
 Default: Disabled More...
 
#define OOLUA_SHARED_HEADER
 Default: MSC: <memory> other compilers: <tr1/memory> More...
 
#define OOLUA_SHARED_TYPE
 Default: std::tr1::shared_ptr More...
 
#define OOLUA_SHARED_CONST_CAST
 Default: std::tr1::const_pointer_cast More...
 

Typedefs

typedef int(* lua_CFunction )(lua_State *vm)
 Lua's C function signature. More...
 

Detailed Description

This file is not part of OOLua, the only reason for it is to allow doxygen to document some things which otherwise it can not do.

Typedef Documentation

typedef int(* lua_CFunction)(lua_State *vm)

Lua's C function signature.

This is a Lua type which is the required signature to bind C functions to Lua.

Parameters
[in]vmThe virtual machine for which a function will operate on
Returns
Number of function returns to Lua