forked from qt-creator/qt-creator
QmlJS: Add documentation for QmlJS::Value.
Also: * Remove unnecessary QmlJS:: qualifications in existing documentation. * Remove unnecessary explicit links in the documentation. Change-Id: Icb41941d98b5cfe9d2fb3b3887fafee16635eb13 Reviewed-by: Leandro Melo <leandro.melo@nokia.com>
This commit is contained in:
@@ -44,15 +44,15 @@ using namespace QmlJS::AST;
|
||||
/*!
|
||||
\class QmlJS::Document
|
||||
\brief A Qml or JavaScript document.
|
||||
\sa QmlJS::Snapshot
|
||||
\sa Snapshot
|
||||
|
||||
Documents are usually created by the \l{QmlJS::ModelManagerInterface}
|
||||
and stored in a \l{QmlJS::Snapshot}. They allow access to data such as
|
||||
the file path, source code, abstract syntax tree and the \l{QmlJS::Bind}
|
||||
Documents are usually created by the ModelManagerInterface
|
||||
and stored in a Snapshot. They allow access to data such as
|
||||
the file path, source code, abstract syntax tree and the Bind
|
||||
instance for the document.
|
||||
|
||||
To make sure unused and outdated documents are removed correctly, Document
|
||||
instances are usually accessed through a shared pointer, see \l{Document::Ptr}.
|
||||
instances are usually accessed through a shared pointer, see Document::Ptr.
|
||||
|
||||
Documents in a Snapshot are immutable: They, or anything reachable through them,
|
||||
must not be changed. This allows Documents to be shared freely among threads
|
||||
@@ -62,9 +62,9 @@ using namespace QmlJS::AST;
|
||||
/*!
|
||||
\class QmlJS::LibraryInfo
|
||||
\brief A Qml library.
|
||||
\sa QmlJS::Snapshot
|
||||
\sa Snapshot
|
||||
|
||||
A LibraryInfo is created when the \l{QmlJS::ModelManagerInterface} finds
|
||||
A LibraryInfo is created when the ModelManagerInterface finds
|
||||
a Qml library and parses the qmldir file. The instance holds information about
|
||||
which Components the library provides and which plugins to load.
|
||||
|
||||
@@ -76,12 +76,12 @@ using namespace QmlJS::AST;
|
||||
/*!
|
||||
\class QmlJS::Snapshot
|
||||
\brief A set of Document::Ptr and LibraryInfo instances.
|
||||
\sa QmlJS::Document QmlJS::LibraryInfo
|
||||
\sa Document LibraryInfo
|
||||
|
||||
A Snapshot holds and offers access to a set of Document and LibraryInfo instances.
|
||||
|
||||
Usually Snapshots are copies of the snapshot maintained and updated by the
|
||||
\l{QmlJS::ModelManagerInterface} that updates its instance as parsing
|
||||
ModelManagerInterface that updates its instance as parsing
|
||||
threads finish and new information becomes available.
|
||||
*/
|
||||
|
||||
|
Reference in New Issue
Block a user