QmlJS: Add initial documentation for the base classes of the code model.

This commit is contained in:
Christian Kamm
2010-09-15 15:25:59 +02:00
parent ee3ad439a8
commit 8df6dd6d7d
3 changed files with 70 additions and 0 deletions

View File

@@ -39,6 +39,22 @@ using namespace QmlJS;
using namespace QmlJS::AST;
using namespace QmlJS::Interpreter;
/*!
\class QmlJS::Bind
\brief Collected information about a single Document.
\sa QmlJS::Document QmlJS::Link
Each QmlJS::Document owns a 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::Interpreter::Context} using \l{QmlJS::Link}.
The document's imports are classified and available through fileImports(),
directoryImports() and libraryImports().
It allows AST to code model lookup through findQmlObject() and findFunctionScope().
*/
Bind::Bind(Document *doc)
: _doc(doc),
_currentObjectValue(0),