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

@@ -48,16 +48,18 @@ using namespace QmlJS::AST;
/*!
\class QmlJS::Bind
\brief Collected information about a single Document.
\sa QmlJS::Document QmlJS::Link
\sa QmlJS::Document QmlJS::Context
Each QmlJS::Document owns a instance of Bind. It provides access to data
Each QmlJS::Document owns an instance of Bind. It provides access to data
that can be derived by looking at the document in isolation. If you need
information that goes beyond that, you need to create a
\l{QmlJS::Context} using \l{QmlJS::Link}.
information that goes beyond that, you need to use a
\l{QmlJS::Context}.
The document's imports are classified and available through imports().
It allows AST to code model lookup through findQmlObject() and findFunctionScope().
This class makes the structural information found in the AST available
for analysis through \l{QmlJS::Value} instances. See findQmlObject(),
idEnvironment(), rootObjectValue() and findAttachedJSScope().
*/
Bind::Bind(Document *doc, QList<DiagnosticMessage> *messages, bool isJsLibrary, const QList<ImportInfo> &jsImports)