Add note about State tracking of Type_Conversions

2015-01-09 16:14:47 -07:00
parent 2e02273673
commit 12533ce3e1
1 changed files with 2 additions and 0 deletions
--- a/include/chaiscript/language/chaiscript_engine.hpp
+++ b/include/chaiscript/language/chaiscript_engine.hpp
@@ -581,6 +581,8 @@ namespace chaiscript
    }

    /// \brief Represents the current state of the ChaiScript system. State and be saved and restored
+    /// \warning State object does not contain the user defined type conversions of the engine. They
+    ///          are left out due to performance considerations involved in tracking the state
    /// \sa ChaiScript::get_state
    /// \sa ChaiScript::set_state
    struct State