QmlJS: Documentation.

Change-Id: I2a095e38b7d79a5fb39a16d8f32b48c8e28132f6
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
Reviewed-by: Fawzi Mohamed <fawzi.mohamed@nokia.com>
This commit is contained in:
Christian Kamm
2011-11-01 14:01:07 +01:00
parent 5cc536cd5a
commit a51120b7db
10 changed files with 55 additions and 23 deletions

View File

@@ -37,6 +37,20 @@
using namespace QmlJS;
using namespace QmlJS::AST;
/*!
\class QmlJS::Context
\brief Holds information about relationships between documents in a QmlJS::Snapshot.
\sa QmlJS::Document QmlJS::Link QmlJS::Snapshot
Contexts are usually created through \l{QmlJS::Link}.
Once created, a Context is immutable and can be freely shared between threads.
Their main purpose is to allow lookup of types with lookupType() and resolving
of references through lookupReference(). Information about the imports of
a QmlJS::Document can be accessed with imports().
*/
ContextPtr Context::create(const QmlJS::Snapshot &snapshot, ValueOwner *valueOwner, const ImportsPerDocument &imports)
{
QSharedPointer<Context> result(new Context(snapshot, valueOwner, imports));