Add documentation to the set_state get_state functions
This commit is contained in:
@@ -345,6 +345,11 @@ namespace chaiscript
|
||||
typename Eval_Engine::State engine_state;
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns a state object that represents the current
|
||||
* set of loaded files, the set of global variables and
|
||||
* the set of initialized functions
|
||||
*/
|
||||
State get_state()
|
||||
{
|
||||
boost::lock_guard<boost::recursive_mutex> l(use_mutex);
|
||||
@@ -356,6 +361,9 @@ namespace chaiscript
|
||||
return s;
|
||||
}
|
||||
|
||||
/**
|
||||
* Restores the state from a saved State object.
|
||||
*/
|
||||
void set_state(const State &t_state)
|
||||
{
|
||||
boost::lock_guard<boost::recursive_mutex> l(use_mutex);
|
||||
|
Reference in New Issue
Block a user