generic-library/ChaiScript
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More documentation updates.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

6
Doxyfile.in
View File

@@ -420,7 +420,7 @@ SORT_MEMBER_DOCS = YES
# by member name. If set to NO (the default) the members will appear in # by member name. If set to NO (the default) the members will appear in
# declaration order. # declaration order.
SORT_BRIEF_DOCS = NO SORT_BRIEF_DOCS = YES
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
# will sort the (brief and detailed) documentation of class members so that # will sort the (brief and detailed) documentation of class members so that
@@ -436,7 +436,7 @@ SORT_MEMBERS_CTORS_1ST = NO
# hierarchy of group names into alphabetical order. If set to NO (the default) # hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order. # the group names will appear in their defined order.
SORT_GROUP_NAMES = NO SORT_GROUP_NAMES = YES
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
# sorted by fully-qualified names, including namespaces. If set to # sorted by fully-qualified names, including namespaces. If set to
@@ -446,7 +446,7 @@ SORT_GROUP_NAMES = NO
# Note: This option applies only to the class list, not to the # Note: This option applies only to the class list, not to the
# alphabetical list. # alphabetical list.
SORT_BY_SCOPE_NAME = NO SORT_BY_SCOPE_NAME = YES
# The GENERATE_TODOLIST tag can be used to enable (YES) or # The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo # disable (NO) the todo list. This list is created by putting \todo

2
include/chaiscript/chaiscript.hpp
View File

@@ -27,7 +27,7 @@
/// \namespace chaiscript /// \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 /// \namespace chaiscript::detail
/// \brief Classes and functions reserved for internal use. Items in this namespace are not supported. /// \brief Classes and functions reserved for internal use. Items in this namespace are not supported.

3
include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp
View File

@@ -221,6 +221,9 @@ namespace chaiscript
typedef boost::shared_ptr<chaiscript::detail::Dynamic_Conversion> Dynamic_Cast_Conversion; 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 /// 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, /// 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 /// if you have a type that is introduced in a loadable module and is used by multiple modules

4
include/chaiscript/dispatchkit/proxy_functions.hpp
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; 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; typedef boost::shared_ptr<const dispatch::Proxy_Function_Base> Const_Proxy_Function;
namespace exception namespace exception

2
include/chaiscript/language/chaiscript_common.hpp
View File

@@ -12,6 +12,7 @@
namespace chaiscript namespace chaiscript
{ {
/// Signature of module entry point that all binary loadable modules must implement.
typedef ModulePtr (*Create_Module_Func)(); typedef ModulePtr (*Create_Module_Func)();
/// Types of AST nodes available to the parser and eval /// Types of AST nodes available to the parser and eval
@@ -52,6 +53,7 @@ namespace chaiscript
File_Position() : line(0), column(0) { } 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; typedef boost::shared_ptr<struct AST_Node> AST_NodePtr;