More documentation updates.

This commit is contained in:
Jason Turner
2011-04-04 07:08:28 -06:00
parent 0d238b1617
commit f1918f147d
5 changed files with 13 additions and 4 deletions

View File

@@ -27,7 +27,7 @@
/// \namespace chaiscript
/// \brief Every API call that the average user will be concerned with.
/// \brief Namespace chaiscript contains every API call that the average user will be concerned with.
/// \namespace chaiscript::detail
/// \brief Classes and functions reserved for internal use. Items in this namespace are not supported.

View File

@@ -221,6 +221,9 @@ namespace chaiscript
typedef boost::shared_ptr<chaiscript::detail::Dynamic_Conversion> Dynamic_Cast_Conversion;
/// \brief Used to register a base / parent class relationship with ChaiScript. Necessary if you
/// want automatic conversions up your inheritance hierarchy.
///
/// Create a new base class registration for applying to a module or to the chaiscript engine
/// Currently, due to limitations in module loading on Windows, and for the sake of portability,
/// if you have a type that is introduced in a loadable module and is used by multiple modules

View File

@@ -175,7 +175,11 @@ namespace chaiscript
};
}
/// \brief Common typedef used for passing of any registered function in ChaiScript
typedef boost::shared_ptr<dispatch::Proxy_Function_Base> Proxy_Function;
/// \brief Const version of Proxy_Function chaiscript. Points to a const Proxy_Function. This is how most registered functions
/// are handled internally.
typedef boost::shared_ptr<const dispatch::Proxy_Function_Base> Const_Proxy_Function;
namespace exception

View File

@@ -12,6 +12,7 @@
namespace chaiscript
{
/// Signature of module entry point that all binary loadable modules must implement.
typedef ModulePtr (*Create_Module_Func)();
/// Types of AST nodes available to the parser and eval
@@ -52,6 +53,7 @@ namespace chaiscript
File_Position() : line(0), column(0) { }
};
/// \brief Typedef for pointers to AST_Node objects. Used in building of the AST_Node tree
typedef boost::shared_ptr<struct AST_Node> AST_NodePtr;