Commit 41411165 authored by Leena Miettinen's avatar Leena Miettinen
Browse files

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: default avatarEike Ziller <eike.ziller@digia.com>
parent 44072532
......@@ -48,7 +48,8 @@
\mainclass
\threadsafe
\brief Defines a collection of related components that can be viewed as a unit.
\brief The Aggregate class defines a collection of related components that
can be viewed as a unit.
An Aggregate is a collection of components that are handled as a unit,
such that each component exposes the properties and behavior of the
......
......@@ -381,13 +381,15 @@ void Document::addUndefinedMacroUse(const QByteArray &name, unsigned offset)
/*!
\class Document::MacroUse
\brief Represents the usage of a macro in a \l {Document}.
\brief The MacroUse class represents the usage of a macro in a
\l {Document}.
\sa Document::UndefinedMacroUse
*/
/*!
\class Document::UndefinedMacroUse
\brief Represents a macro that was looked up, but not found.
\brief The UndefinedMacroUse class represents a macro that was looked for,
but not found.
Holds data about the reference to a macro in an \tt{#ifdef} or \tt{#ifndef}
or argument to the \tt{defined} operator inside an \tt{#if} or \tt{#elif} that does
......
......@@ -33,7 +33,8 @@ using namespace CPlusPlus;
/*!
\class Client
\brief A notification interface for for C++ preprocessor.
\brief The Client class implements a notification interface for the
C++ preprocessor.
*/
/*!
......
......@@ -35,7 +35,7 @@
/*!
\class ExtensionSystem::IPlugin
\mainclass
\brief Base class for all plugins.
\brief The IPlugin class is the base class for all plugins.
The IPlugin class is an abstract class that must be implemented
once for each plugin.
......
......@@ -35,7 +35,8 @@
/*!
\class ExtensionSystem::PluginDetailsView
\brief Widget that displays the contents of a PluginSpec.
\brief The PluginDetailsView class implements a widget that displays the
contents of a PluginSpec.
Can be used for integration in the application that
uses the plugin manager.
......
......@@ -35,7 +35,8 @@
/*!
\class ExtensionSystem::PluginErrorView
\brief Widget that displays the state and error message of a PluginSpec.
\brief The PluginErrorView class implements a widget that displays the
state and error message of a PluginSpec.
Can be used for integration in the application that
uses the plugin manager.
......
......@@ -76,7 +76,8 @@ enum { debugLeaks = 0 };
\class ExtensionSystem::PluginManager
\mainclass
\brief Core plugin system that manages the plugins, their life cycle and their registered objects.
\brief The PluginManager class implements the core plugin system that
manages the plugins, their life cycle, and their registered objects.
The plugin manager is used for the following tasks:
\list
......
......@@ -63,7 +63,8 @@
/*!
\class ExtensionSystem::PluginDependency
\brief Struct that contains the name and required compatible version number of a plugin's dependency.
\brief The PluginDependency class contains the name and required compatible
version number of a plugin's dependency.
This reflects the data of a dependency tag in the plugin's xml description file.
The name and version are used to resolve the dependency, i.e. a plugin with the given name and
......@@ -102,7 +103,8 @@
/*!
\class ExtensionSystem::PluginSpec
\brief Contains the information of the plugins xml description file and
\brief The PluginSpec class contains the information of the plugin's XML
description file and
information about the plugin's current state.
The plugin spec is also filled with more information as the plugin
......
......@@ -42,7 +42,8 @@
/*!
\class ExtensionSystem::PluginView
\brief Widget that shows a list of all plugins and their state.
\brief The PluginView class implements a widget that shows a list of all
plugins and their state.
This can be embedded e.g. in a dialog in the application that
uses the plugin manager.
......
......@@ -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
......
......@@ -29,8 +29,8 @@
/*!
\class QRangeModel
\brief The QRangeModel class, helps users to build components that depend
on some value and/or position to be in a certain range previously defined
\brief The QRangeModel class helps users to build components that depend
on some value and/or position to be in a certain range previously defined.
With this class, the user sets a value range and a position range, which
represent the valid values/positions the model can assume. It is worth telling
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment