forked from qt-creator/qt-creator
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces and \brief commands, so the following wording must be used: "The xxx class yyy ..." Change-Id: Id231f30e8464898b776888d5423523de404aae34 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
@@ -30,7 +30,8 @@
|
||||
/*!
|
||||
\class QmlJS::PersistentTrie::Trie
|
||||
|
||||
\brief Implements a trie that is persistent (not on disk but in memory).
|
||||
\brief The Trie class implements a trie that is
|
||||
persistent (not on disk but in memory).
|
||||
|
||||
This means that several versions can coexist, as adding an element
|
||||
is non destructive, and as much as possible is shared.
|
||||
|
||||
@@ -41,7 +41,7 @@ using namespace QmlJS::AST;
|
||||
|
||||
/*!
|
||||
\class QmlJS::Bind
|
||||
\brief Collected information about a single Document.
|
||||
\brief The Bind class collects information about a single Document.
|
||||
\sa Document Context
|
||||
|
||||
Each Document owns an instance of Bind. It provides access to data
|
||||
|
||||
@@ -36,7 +36,8 @@ using namespace QmlJS::AST;
|
||||
|
||||
/*!
|
||||
\class QmlJS::Context
|
||||
\brief Holds information about relationships between documents in a Snapshot.
|
||||
\brief The Context class holds information about relationships between
|
||||
documents in a Snapshot.
|
||||
\sa Document Link Snapshot
|
||||
|
||||
Contexts are usually created through Link. Once created, a Context is immutable
|
||||
|
||||
@@ -39,7 +39,7 @@ using namespace QmlJS::AST;
|
||||
|
||||
/*!
|
||||
\class QmlJS::Document
|
||||
\brief A Qml or JavaScript document.
|
||||
\brief The Document class creates a QML or JavaScript document.
|
||||
\sa Snapshot
|
||||
|
||||
Documents are usually created by the ModelManagerInterface
|
||||
@@ -57,7 +57,7 @@ using namespace QmlJS::AST;
|
||||
|
||||
/*!
|
||||
\class QmlJS::LibraryInfo
|
||||
\brief A Qml library.
|
||||
\brief The LibraryInfo class creates a QML library.
|
||||
\sa Snapshot
|
||||
|
||||
A LibraryInfo is created when the ModelManagerInterface finds
|
||||
@@ -71,11 +71,10 @@ using namespace QmlJS::AST;
|
||||
|
||||
/*!
|
||||
\class QmlJS::Snapshot
|
||||
\brief A set of Document::Ptr and LibraryInfo instances.
|
||||
\brief The Snapshot class holds and offers access to a set of
|
||||
Document::Ptr and LibraryInfo instances.
|
||||
\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
|
||||
ModelManagerInterface that updates its instance as parsing
|
||||
threads finish and new information becomes available.
|
||||
|
||||
@@ -37,7 +37,7 @@ using namespace QmlJS;
|
||||
|
||||
/*!
|
||||
\class QmlJS::Evaluate
|
||||
\brief Evaluates \l{AST::Node}s to \l{Value}s.
|
||||
\brief The Evaluate class evaluates \l{AST::Node}s to \l{Value}s.
|
||||
\sa Value ScopeChain
|
||||
|
||||
The Evaluate visitor is constructed with a ScopeChain and accepts JavaScript
|
||||
|
||||
@@ -53,7 +53,8 @@ using namespace QmlJS::AST;
|
||||
|
||||
/*!
|
||||
\class QmlJS::Value
|
||||
\brief Abstract base class for the result of a JS expression.
|
||||
\brief The Value class is an abstract base class for the result of a
|
||||
JS expression.
|
||||
\sa Evaluate ValueOwner ValueVisitor
|
||||
|
||||
A Value represents a category of JavaScript values, such as number
|
||||
|
||||
@@ -122,7 +122,7 @@ public:
|
||||
|
||||
/*!
|
||||
\class QmlJS::Link
|
||||
\brief Creates a Context for a Snapshot.
|
||||
\brief The Link class creates a Context for a Snapshot.
|
||||
\sa Context Snapshot
|
||||
|
||||
Initializes a context by resolving imports. This is an expensive operation.
|
||||
|
||||
@@ -33,7 +33,8 @@ using namespace QmlJS;
|
||||
|
||||
/*!
|
||||
\class QmlJS::ModelManagerInterface
|
||||
\brief Interface to the global state of the QmlJS code model.
|
||||
\brief The ModelManagerInterface class acts as an interface to the
|
||||
global state of the QmlJS code model.
|
||||
\sa QmlJS::Document QmlJS::Snapshot QmlJSTools::Internal::ModelManager
|
||||
|
||||
The ModelManagerInterface is an interface for global state and actions in
|
||||
|
||||
@@ -36,7 +36,8 @@ using namespace QmlJS;
|
||||
|
||||
/*!
|
||||
\class QmlJS::ScopeChain
|
||||
\brief Describes the scopes used for global lookup in a specific location.
|
||||
\brief The ScopeChain class describes the scopes used for global lookup in
|
||||
a specific location.
|
||||
\sa Document Context ScopeBuilder
|
||||
|
||||
A ScopeChain is used to perform global lookup with the lookup() method and
|
||||
|
||||
@@ -35,7 +35,7 @@ using namespace QmlJS;
|
||||
|
||||
/*!
|
||||
\class QmlJS::ValueOwner
|
||||
\brief Manages the lifetime of \l{QmlJS::Value}s.
|
||||
\brief The ValueOwner class manages the lifetime of \l{QmlJS::Value}s.
|
||||
\sa QmlJS::Value
|
||||
|
||||
Values are usually created on a ValueOwner. When the ValueOwner is destroyed
|
||||
|
||||
Reference in New Issue
Block a user