Corrects some Doxygen comments and adds a few others of interest.

This was SVN commit r11209.
This commit is contained in:
historic_bruno
2012-03-01 03:55:05 +00:00
parent a247da1585
commit 7fa6afac37
18 changed files with 190 additions and 114 deletions
@@ -47,8 +47,24 @@
#include "scriptinterface/ScriptExtraHeaders.h"
/**
* @file
* Abstractions of various SpiderMonkey features.
* Engine code should be using functions of these interfaces rather than
* directly accessing the underlying JS api.
*/
////////////////////////////////////////////////////////////////
/**
* Abstraction around a SpiderMonkey JSRuntime.
* Each ScriptRuntime can be used to initialize several ScriptInterface
* contexts which can then share data, but a single ScriptRuntime should
* only be used on a single thread.
*
* (One means to share data between threads and runtimes is to create
* a ScriptInterface::StructuredClone.)
*/
class ScriptRuntime
{
public: