From f1918f147d3ca57171de2e2b5a053a250c745225 Mon Sep 17 00:00:00 2001 From: Jason Turner Date: Mon, 4 Apr 2011 07:08:28 -0600 Subject: [PATCH] More documentation updates. --- Doxyfile.in | 6 +++--- include/chaiscript/chaiscript.hpp | 2 +- include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp | 3 +++ include/chaiscript/dispatchkit/proxy_functions.hpp | 4 ++++ include/chaiscript/language/chaiscript_common.hpp | 2 ++ 5 files changed, 13 insertions(+), 4 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index 064d54f..e9e5b6c 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -420,7 +420,7 @@ SORT_MEMBER_DOCS = YES # by member name. If set to NO (the default) the members will appear in # declaration order. -SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = YES # 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 @@ -436,7 +436,7 @@ SORT_MEMBERS_CTORS_1ST = NO # hierarchy of group names into alphabetical order. If set to NO (the default) # 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 # 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 # alphabetical list. -SORT_BY_SCOPE_NAME = NO +SORT_BY_SCOPE_NAME = YES # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo diff --git a/include/chaiscript/chaiscript.hpp b/include/chaiscript/chaiscript.hpp index 1a6cecd..5c5ff5a 100644 --- a/include/chaiscript/chaiscript.hpp +++ b/include/chaiscript/chaiscript.hpp @@ -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. diff --git a/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp b/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp index 30f7d89..1ee3c99 100644 --- a/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp +++ b/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp @@ -221,6 +221,9 @@ namespace chaiscript typedef boost::shared_ptr 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 diff --git a/include/chaiscript/dispatchkit/proxy_functions.hpp b/include/chaiscript/dispatchkit/proxy_functions.hpp index 8c1fb52..a29a06c 100644 --- a/include/chaiscript/dispatchkit/proxy_functions.hpp +++ b/include/chaiscript/dispatchkit/proxy_functions.hpp @@ -175,7 +175,11 @@ namespace chaiscript }; } + /// \brief Common typedef used for passing of any registered function in ChaiScript typedef boost::shared_ptr 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_Proxy_Function; namespace exception diff --git a/include/chaiscript/language/chaiscript_common.hpp b/include/chaiscript/language/chaiscript_common.hpp index f0a557a..1479d38 100644 --- a/include/chaiscript/language/chaiscript_common.hpp +++ b/include/chaiscript/language/chaiscript_common.hpp @@ -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 AST_NodePtr;