diff --git a/include/chaiscript/chaiscript.hpp b/include/chaiscript/chaiscript.hpp index 903eb38..c8e9e9a 100644 --- a/include/chaiscript/chaiscript.hpp +++ b/include/chaiscript/chaiscript.hpp @@ -75,7 +75,7 @@ /// /// @subsection compiling Compiling ChaiScript Applications /// -/// ChaiScript is a header only library with only one dependecy: The +/// ChaiScript is a header only library with only one dependency: The /// operating system provided dynamic library loader, which has to be specified on some platforms. /// /// @subsubsection compilinggcc Compiling with GCC @@ -112,7 +112,7 @@ /// /// @subsubsection evalmethod Method 'eval' /// -/// The eval method is somewhat more verbose and can be used to get typesafely return values +/// The eval method is somewhat more verbose and can be used to get type safely return values /// from the script. /// /// ~~~~~~~~{.cpp} @@ -311,7 +311,7 @@ /// As much as possible, ChaiScript attempts to convert between &, *, const &, const *, std::shared_ptr, /// std::shared_ptr, std::reference_wrapper, std::reference_wrapper and value types automatically. /// -/// If a chaiscript::var object was created in C++ from a pointer, it cannot be convered to a shared_ptr (this would add invalid reference counting). +/// If a chaiscript::var object was created in C++ from a pointer, it cannot be converted to a shared_ptr (this would add invalid reference counting). /// Const may be added, but never removed. /// /// The take away is that you can pretty much expect function calls to Just Work when you need them to. diff --git a/include/chaiscript/dispatchkit/any.hpp b/include/chaiscript/dispatchkit/any.hpp index ce76175..39ff2fa 100644 --- a/include/chaiscript/dispatchkit/any.hpp +++ b/include/chaiscript/dispatchkit/any.hpp @@ -28,7 +28,7 @@ namespace chaiscript { virtual ~bad_any_cast() CHAISCRIPT_NOEXCEPT {} - /// \brief Description of what error occured + /// \brief Description of what error occurred virtual const char * what() const CHAISCRIPT_NOEXCEPT CHAISCRIPT_OVERRIDE { return m_what.c_str(); diff --git a/include/chaiscript/dispatchkit/bad_boxed_cast.hpp b/include/chaiscript/dispatchkit/bad_boxed_cast.hpp index 3040b71..b22bde6 100644 --- a/include/chaiscript/dispatchkit/bad_boxed_cast.hpp +++ b/include/chaiscript/dispatchkit/bad_boxed_cast.hpp @@ -46,7 +46,7 @@ namespace chaiscript virtual ~bad_boxed_cast() CHAISCRIPT_NOEXCEPT {} - /// \brief Description of what error occured + /// \brief Description of what error occurred virtual const char * what() const CHAISCRIPT_NOEXCEPT CHAISCRIPT_OVERRIDE { return m_what.c_str(); diff --git a/include/chaiscript/dispatchkit/dispatchkit.hpp b/include/chaiscript/dispatchkit/dispatchkit.hpp index 8c4a7f5..fd539de 100644 --- a/include/chaiscript/dispatchkit/dispatchkit.hpp +++ b/include/chaiscript/dispatchkit/dispatchkit.hpp @@ -173,7 +173,7 @@ namespace chaiscript } - //Add a bit of chaiscript to eval during module implementation + //Add a bit of ChaiScript to eval during module implementation Module &eval(const std::string &str) { m_evals.push_back(str); diff --git a/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp b/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp index 7c46542..359d0a5 100644 --- a/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp +++ b/include/chaiscript/dispatchkit/dynamic_cast_conversion.hpp @@ -258,7 +258,7 @@ namespace chaiscript /// \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, /// if you have a type that is introduced in a loadable module and is used by multiple modules /// (through a tertiary dll that is shared between the modules, static linking the new type diff --git a/include/chaiscript/dispatchkit/exception_specification.hpp b/include/chaiscript/dispatchkit/exception_specification.hpp index 4645c75..e323484 100644 --- a/include/chaiscript/dispatchkit/exception_specification.hpp +++ b/include/chaiscript/dispatchkit/exception_specification.hpp @@ -23,6 +23,7 @@ namespace chaiscript { namespace detail { + /// \todo make this a variadic template struct Exception_Handler_Base { virtual void handle(const Boxed_Value &bv, const Dispatch_Engine &t_engine) = 0; diff --git a/include/chaiscript/dispatchkit/proxy_functions.hpp b/include/chaiscript/dispatchkit/proxy_functions.hpp index 4f9f471..16ceaf8 100644 --- a/include/chaiscript/dispatchkit/proxy_functions.hpp +++ b/include/chaiscript/dispatchkit/proxy_functions.hpp @@ -63,7 +63,7 @@ namespace chaiscript /// Returns a vector containing all of the types of the parameters the function returns/takes /// if the function is variadic or takes no arguments (arity of 0 or -1), the returned - /// value containes exactly 1 Type_Info object: the return type + /// value contains exactly 1 Type_Info object: the return type /// \returns the types of all parameters. const std::vector &get_param_types() const { return m_types; } @@ -182,7 +182,7 @@ namespace chaiscript /// \brief Common typedef used for passing of any registered function in ChaiScript typedef std::shared_ptr Proxy_Function; - /// \brief Const version of Proxy_Function chaiscript. Points to a const Proxy_Function. This is how most registered functions + /// \brief Const version of Proxy_Function. Points to a const Proxy_Function. This is how most registered functions /// are handled internally. typedef std::shared_ptr Const_Proxy_Function; diff --git a/include/chaiscript/dispatchkit/proxy_functions_detail.hpp b/include/chaiscript/dispatchkit/proxy_functions_detail.hpp index 1660a27..fa725f8 100644 --- a/include/chaiscript/dispatchkit/proxy_functions_detail.hpp +++ b/include/chaiscript/dispatchkit/proxy_functions_detail.hpp @@ -118,7 +118,7 @@ namespace chaiscript /** * Used by Proxy_Function_Impl to determine if it is equivalent to another - * Proxy_Function_Impl object. This function is primarly used to prevent + * Proxy_Function_Impl object. This function is primarily used to prevent * registration of two functions with the exact same signatures */ template @@ -166,7 +166,7 @@ namespace chaiscript /** * Used by Proxy_Function_Impl to perform typesafe execution of a function. - * The function attempts to unbox each paramter to the expected type. + * The function attempts to unbox each parameter to the expected type. * if any unboxing fails the execution of the function fails and * the bad_boxed_cast is passed up to the caller. */ diff --git a/include/chaiscript/language/chaiscript_engine.hpp b/include/chaiscript/language/chaiscript_engine.hpp index 0513194..af01ce3 100644 --- a/include/chaiscript/language/chaiscript_engine.hpp +++ b/include/chaiscript/language/chaiscript_engine.hpp @@ -845,7 +845,7 @@ namespace chaiscript /// /// \param[in] t_input Script to execute /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions - /// \param[in] t_filename Optional filename to report to the user for where the error occured. Useful + /// \param[in] t_filename Optional filename to report to the user for where the error occurred. Useful /// in special cases where you are loading a file internally instead of using eval_file /// /// \return result of the script execution @@ -879,7 +879,7 @@ namespace chaiscript } } - /// \brief Loads the file specified by filename, evaluates it, and returns the typesafe result. + /// \brief Loads the file specified by filename, evaluates it, and returns the type safe result. /// \tparam T Type to extract from the result value of the script execution /// \param[in] t_filename File to load and parse. /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions diff --git a/include/chaiscript/language/chaiscript_prelude_docs.hpp b/include/chaiscript/language/chaiscript_prelude_docs.hpp index e817420..eb02f3b 100644 --- a/include/chaiscript/language/chaiscript_prelude_docs.hpp +++ b/include/chaiscript/language/chaiscript_prelude_docs.hpp @@ -112,7 +112,7 @@ class Map }; -/// \brief A concept implemented by string, Vector and Map. It is convertable to Range, default constructable and back_insertable +/// \brief A concept implemented by string, Vector and Map. It is convertible to Range, default constructable and back_insertable class Container { public: @@ -153,10 +153,10 @@ void print(Object o); /// \brief ChaiScript representation of std::string. It is an std::string but only some member are exposed to ChaiScript. /// -/// Because the ChaiScript string object is an std::string, it is directly convertable to and from std::string +/// Because the ChaiScript string object is an std::string, it is directly convertible to and from std::string /// using the chaiscript::boxed_cast and chaiscript::var functions. /// -/// With the exception of string::trim, string::rtrim, string::ltrim, all members are direct passthroughs to the +/// With the exception of string::trim, string::rtrim, string::ltrim, all members are direct pass-throughs to the /// std::string of the same name. /// /// \note Object and function notations are equivalent in ChaiScript. This means that @@ -519,7 +519,7 @@ class Function /// \brief Returns a vector of Type_Info objects that represent the param types for this function. /// The first value in the list is the return type. /// - /// If this function is a conglomeration of several functions (get_contained_values().size() > 0) + /// If this function is a conglomerate of several functions (get_contained_values().size() > 0) /// then the function returns as many Type_Info objects as it can. If the functions contained all have /// the same arity, then it represents the arity. If they have different arities, it returns only /// one value - the return type. @@ -534,7 +534,7 @@ class Function /// \endcode Vector get_param_types() const; - /// \brief Returns true if the function has a guard to it. Always returns falls for a conglomerate function + /// \brief Returns true if the function has a guard to it. Always returns false for a conglomerate function bool has_guard() const; /// \brief Calls the function with the given set of parameters and returns the value; diff --git a/include/chaiscript/utility/utility.hpp b/include/chaiscript/utility/utility.hpp index bd60ef0..3efb525 100644 --- a/include/chaiscript/utility/utility.hpp +++ b/include/chaiscript/utility/utility.hpp @@ -21,8 +21,6 @@ namespace chaiscript namespace utility { - /// \todo Use of this utility, and uniform initializer lists, is causing memory errors in MSVC - template void add_class(ModuleType &t_module, const std::string &t_class_name, diff --git a/samples/memory_leak_test.cpp b/samples/memory_leak_test.cpp index 23a7455..fb58003 100644 --- a/samples/memory_leak_test.cpp +++ b/samples/memory_leak_test.cpp @@ -70,12 +70,12 @@ int main(int /*argc*/, char * /*argv*/[]) { std::string command = ""; // - // this loop increases memoryusage, if RunFile is not called (just hitting enter) + // this loop increases memory usage, if RunFile is not called (just hitting enter) // as soon RunFile gets called, memory will be freed. // - // scenario1 - RunFile gets called every Loop: memoryusage does not change - // scenario2 - RunFile gets never called (just hitting enter): memoryusage increases every loop - // scenario3 - RunFile gets in changing intervals: memoryusage goes up and down, but never as + // scenario1 - RunFile gets called every Loop: memory usage does not change + // scenario2 - RunFile gets never called (just hitting enter): memory usage increases every loop + // scenario3 - RunFile gets in changing intervals: memory usage goes up and down, but never as // low as in case 1 scenario3 : while(command != "quit")