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

@@ -125,15 +125,13 @@ public:
/*!
\class QmlJS::Link
\brief Initializes the Context for a Document.
\sa QmlJS::Document QmlJS::Context
\brief Creates a Context for a Snapshot.
\sa QmlJS::Context QmlJS::Snapshot
Initializes a context by resolving imports and building the root scope
chain. Currently, this is a expensive operation.
Initializes a context by resolving imports. This is an expensive operation.
It's recommended to use a the \l{LookupContext} returned by
\l{QmlJSEditor::SemanticInfo::lookupContext()} instead of building a new
\l{Context} with \l{Link}.
Instead of making a fresh context, consider reusing the one maintained in the
\l{QmlJSEditor::SemanticInfo} of a \l{QmlJSEditor::QmlJSTextEditorWidget}.
*/
Link::Link(const Snapshot &snapshot, const QStringList &importPaths, const LibraryInfo &builtins)