diff --git a/src/libs/aggregation/aggregate.cpp b/src/libs/aggregation/aggregate.cpp
index e6979b0a13dac97fda4939287a8b4e347e21473d..9a4f61c2a37f9fe8d84fc49ccc7159e08a70cf52 100644
--- a/src/libs/aggregation/aggregate.cpp
+++ b/src/libs/aggregation/aggregate.cpp
@@ -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
diff --git a/src/libs/cplusplus/CppDocument.cpp b/src/libs/cplusplus/CppDocument.cpp
index 7df0d2d2e527aa34ae380147108683ff4f45110a..9b92eda5d8d2f2f322ad4db71dec0be3555cf4df 100644
--- a/src/libs/cplusplus/CppDocument.cpp
+++ b/src/libs/cplusplus/CppDocument.cpp
@@ -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
diff --git a/src/libs/cplusplus/PreprocessorClient.cpp b/src/libs/cplusplus/PreprocessorClient.cpp
index f40e6d92c5cf51ed531db8deaea8fe77699dfc06..2e2e069e0d991043595d34e8073a37e62e890ade 100644
--- a/src/libs/cplusplus/PreprocessorClient.cpp
+++ b/src/libs/cplusplus/PreprocessorClient.cpp
@@ -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.
*/
/*!
diff --git a/src/libs/extensionsystem/iplugin.cpp b/src/libs/extensionsystem/iplugin.cpp
index b3cda5f508e49fd0bb2d831f26c260c980c7cef5..132e5078f38766f7231e67dd057218bf7d477c92 100644
--- a/src/libs/extensionsystem/iplugin.cpp
+++ b/src/libs/extensionsystem/iplugin.cpp
@@ -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.
diff --git a/src/libs/extensionsystem/plugindetailsview.cpp b/src/libs/extensionsystem/plugindetailsview.cpp
index cb9e792443f0e33dfc740a209ab56ea7fb8817be..a7464cce177977e4d26007f883f248a49984d382 100644
--- a/src/libs/extensionsystem/plugindetailsview.cpp
+++ b/src/libs/extensionsystem/plugindetailsview.cpp
@@ -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.
diff --git a/src/libs/extensionsystem/pluginerrorview.cpp b/src/libs/extensionsystem/pluginerrorview.cpp
index 81d3c63f1b89c520417dee1155e8cbbe357757ca..d5c4fe7f568b6cabeafc9d1198ef2c144e3d58fb 100644
--- a/src/libs/extensionsystem/pluginerrorview.cpp
+++ b/src/libs/extensionsystem/pluginerrorview.cpp
@@ -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.
diff --git a/src/libs/extensionsystem/pluginmanager.cpp b/src/libs/extensionsystem/pluginmanager.cpp
index 19680cb603f90a66c752381694da65d3cd033fbe..f88804f7da1e57d58a1d409e0306c264892e1560 100644
--- a/src/libs/extensionsystem/pluginmanager.cpp
+++ b/src/libs/extensionsystem/pluginmanager.cpp
@@ -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
diff --git a/src/libs/extensionsystem/pluginspec.cpp b/src/libs/extensionsystem/pluginspec.cpp
index c9ccce4ce20c7bbe18b93039dc3ed972e3dd648c..ed0d3350abc4fc404b4ead0cdfb6e5fceb99ef39 100644
--- a/src/libs/extensionsystem/pluginspec.cpp
+++ b/src/libs/extensionsystem/pluginspec.cpp
@@ -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
diff --git a/src/libs/extensionsystem/pluginview.cpp b/src/libs/extensionsystem/pluginview.cpp
index 10f8c2484c84466150861ec2c730003003e32c74..df735c17a94702b17f11f09f487f0c2902b16694 100644
--- a/src/libs/extensionsystem/pluginview.cpp
+++ b/src/libs/extensionsystem/pluginview.cpp
@@ -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.
diff --git a/src/libs/qmljs/persistenttrie.cpp b/src/libs/qmljs/persistenttrie.cpp
index 15bed733fe2e0ce36a0728adc8c41cef44c45410..e12fa90875c4c678b57deb0d0ffbc004ef09774c 100644
--- a/src/libs/qmljs/persistenttrie.cpp
+++ b/src/libs/qmljs/persistenttrie.cpp
@@ -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.
diff --git a/src/libs/qmljs/qmljsbind.cpp b/src/libs/qmljs/qmljsbind.cpp
index 05d2e143df89396a297b4c2392d3543a7f85cd7e..54b9a204f265b8317c6b25b2680921bb91095508 100644
--- a/src/libs/qmljs/qmljsbind.cpp
+++ b/src/libs/qmljs/qmljsbind.cpp
@@ -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
diff --git a/src/libs/qmljs/qmljscontext.cpp b/src/libs/qmljs/qmljscontext.cpp
index 8bcfb648ceb9dc95b8996529367b656cb3abdfe0..ff601e37a6363da29cb4cd13e5c642d9a7c0b852 100644
--- a/src/libs/qmljs/qmljscontext.cpp
+++ b/src/libs/qmljs/qmljscontext.cpp
@@ -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
diff --git a/src/libs/qmljs/qmljsdocument.cpp b/src/libs/qmljs/qmljsdocument.cpp
index a7eb00c354d16985675d3cf6a8899e2e47d12c12..b75a74aae955d7cabb4c34d7ce797c2a2be0ca07 100644
--- a/src/libs/qmljs/qmljsdocument.cpp
+++ b/src/libs/qmljs/qmljsdocument.cpp
@@ -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.
diff --git a/src/libs/qmljs/qmljsevaluate.cpp b/src/libs/qmljs/qmljsevaluate.cpp
index b0ea53ec211076a0b4fdff2775e050883eee5a6a..9f0db46a7a2d499f4b9a7deb725417545c57de53 100644
--- a/src/libs/qmljs/qmljsevaluate.cpp
+++ b/src/libs/qmljs/qmljsevaluate.cpp
@@ -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
diff --git a/src/libs/qmljs/qmljsinterpreter.cpp b/src/libs/qmljs/qmljsinterpreter.cpp
index c9b1f4381a538f7235c668f6e842782bb8ff579a..c74d5c4086c5eba4b350e922dc512fa6a4b61427 100644
--- a/src/libs/qmljs/qmljsinterpreter.cpp
+++ b/src/libs/qmljs/qmljsinterpreter.cpp
@@ -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
diff --git a/src/libs/qmljs/qmljslink.cpp b/src/libs/qmljs/qmljslink.cpp
index 2d5672fa20e412c66684b546bf2c21ddfa5fdb3a..1515286a54fd240d02b8755552ba8a5f3976f213 100644
--- a/src/libs/qmljs/qmljslink.cpp
+++ b/src/libs/qmljs/qmljslink.cpp
@@ -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.
diff --git a/src/libs/qmljs/qmljsmodelmanagerinterface.cpp b/src/libs/qmljs/qmljsmodelmanagerinterface.cpp
index 1be1f2c6836d5d193a791ee2591461e5fca96b8d..34b2eeb856049694ea2cfda9125bea1d1b2e7c09 100644
--- a/src/libs/qmljs/qmljsmodelmanagerinterface.cpp
+++ b/src/libs/qmljs/qmljsmodelmanagerinterface.cpp
@@ -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
diff --git a/src/libs/qmljs/qmljsscopechain.cpp b/src/libs/qmljs/qmljsscopechain.cpp
index a0a9bf0f9120ae26a2791fe80227729898c38c99..a25c094db4d64983f658b24a8c508f163a4755cd 100644
--- a/src/libs/qmljs/qmljsscopechain.cpp
+++ b/src/libs/qmljs/qmljsscopechain.cpp
@@ -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
diff --git a/src/libs/qmljs/qmljsvalueowner.cpp b/src/libs/qmljs/qmljsvalueowner.cpp
index 2c47a71f4563a713109c146fa7418a244534db23..ac0ceb9c6a3c483447a8a01f7c7ef7e8085012b2 100644
--- a/src/libs/qmljs/qmljsvalueowner.cpp
+++ b/src/libs/qmljs/qmljsvalueowner.cpp
@@ -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
diff --git a/src/libs/qtcomponents/styleitem/qrangemodel.cpp b/src/libs/qtcomponents/styleitem/qrangemodel.cpp
index e9425a309d16f58881a375bb8bcd7ba3469219f8..8217ff3e44c1e81424beba8cebf49bb930e73dd3 100644
--- a/src/libs/qtcomponents/styleitem/qrangemodel.cpp
+++ b/src/libs/qtcomponents/styleitem/qrangemodel.cpp
@@ -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
diff --git a/src/libs/qtcreatorcdbext/symbolgroup.cpp b/src/libs/qtcreatorcdbext/symbolgroup.cpp
index 0a4361147f57a1a54f247cf094a29417ab444236..5fc8113fdc1d53c17ee3b9875f0f2a24e517e68b 100644
--- a/src/libs/qtcreatorcdbext/symbolgroup.cpp
+++ b/src/libs/qtcreatorcdbext/symbolgroup.cpp
@@ -46,7 +46,9 @@ enum { debug = 0 };
// ------------- SymbolGroup
/*!
- \class SymbolGroup A symbol group storing a tree of expanded symbols rooted on a fake "locals" root element.
+ \class SymbolGroup
+ \brief The SymbolGroup class creates a symbol group storing a tree of
+ expanded symbols rooted on a fake "locals" root element.
Provides a find() method based on inames ("locals.this.i1.data") and
dump() methods used for GDBMI-format dumping and debug helpers.
@@ -533,8 +535,10 @@ AbstractSymbolGroupNode *SymbolGroup::find(const std::string &iname) const
/*!
\class LocalsSymbolGroup
+ \brief The LocalsSymbolGroup class creates a Symbol group representing the
+ Locals view.
- Symbol group representing the Locals view. It is firmly associated
+ It is firmly associated
with stack frame, function (module) and thread.
\ingroup qtcreatorcdbext
*/
@@ -624,7 +628,9 @@ std::string LocalsSymbolGroup::module() const
/*!
\class WatchesSymbolGroup
- Watch symbol group. Contains watches as added by Qt Creator as iname='watch.0',
+ \brief The WatchesSymbolGroup class creates a watch symbol group.
+
+ Contains watches as added by \QC as iname='watch.0',
name='<expression>'. The IDebugSymbolGroup is created without scope.
\ingroup qtcreatorcdbext
*/
diff --git a/src/libs/qtcreatorcdbext/symbolgroupnode.cpp b/src/libs/qtcreatorcdbext/symbolgroupnode.cpp
index 8e671e6451f5797e8d3c5986d2638772aae2fcaa..12e79b7372b4743d0509091283b3f4dd84964c7e 100644
--- a/src/libs/qtcreatorcdbext/symbolgroupnode.cpp
+++ b/src/libs/qtcreatorcdbext/symbolgroupnode.cpp
@@ -90,7 +90,8 @@ inline std::ostream &operator<<(std::ostream &str, const DebugNodeFlags &f)
/*!
\class AbstractSymbolGroupNode
- Abstract base class for a node of SymbolGroup providing the child list interface.
+ \brief The AbstractSymbolGroupNode class is an abstract base class for a
+ node of SymbolGroup providing the child list interface.
\ingroup qtcreatorcdbext
*/
AbstractSymbolGroupNode::AbstractSymbolGroupNode(const std::string &name,
@@ -207,7 +208,8 @@ void AbstractSymbolGroupNode::setParent(AbstractSymbolGroupNode *n)
/*! \class BaseSymbolGroupNode
- Base class for a node of SymbolGroup with a flat list of children.
+ \brief The BaseSymbolGroupNode class is the base class for a node of
+ SymbolGroup with a flat list of children.
\ingroup qtcreatorcdbext
*/
@@ -276,9 +278,11 @@ std::ostream &operator<<(std::ostream &str, const DEBUG_SYMBOL_PARAMETERS ¶m
return str;
}
-/*! \struct DumpParameters
+/*!
+ \class DumpParameters
- All parameters for GDBMI dumping of a symbol group in one struct.
+ \brief The DumpParameters class contains all parameters for GDBMI dumping
+ of a symbol group in one class.
The debugging engine passes maps of type names/inames to special
integer values indicating hex/dec, etc.
\ingroup qtcreatorcdbext
@@ -580,7 +584,8 @@ void ErrorSymbolGroupNode::debug(std::ostream &os, const std::string &visitingFu
/*! \class SymbolGroupNode
- \brief 'Real' node within a symbol group, identified by its index in IDebugSymbolGroup.
+ \brief The SymbolGroupNode class represents a \e real node within a symbol
+ group, identified by its index in IDebugSymbolGroup.
Provides accessors for fixed-up symbol group value and a dumping facility
consisting of:
@@ -1472,8 +1477,11 @@ static inline StringStringPair arrayIndexNameIname(int index)
/*! \class ReferenceSymbolGroupNode
- Artificial node referencing another (real) SymbolGroupNode (added symbol or
- symbol from within an expanded linked list structure). Forwards the
+ \brief The ReferenceSymbolGroupNode class is an artificial node referencing
+ another (real) SymbolGroupNode (added symbol or symbol from within an
+ expanded linked list structure).
+
+ Forwards the
dumping to the referenced node using its own name.
\ingroup qtcreatorcdbext */
@@ -1509,7 +1517,8 @@ void ReferenceSymbolGroupNode::debug(std::ostream &str, const std::string &visit
/*! \class MapNodeSymbolGroupNode
- \brief A [fake] map node with a fake array index and key/value entries consisting
+ \brief The MapNodeSymbolGroupNode class is a [fake] map node with a fake
+ array index and key/value entries consisting
of ReferenceSymbolGroupNode.
\ingroup qtcreatorcdbext
*/
@@ -1559,9 +1568,11 @@ void MapNodeSymbolGroupNode::debug(std::ostream &os, const std::string &visiting
/*! \class SymbolGroupNodeVisitor
- Visitor that takes care of iterating over the nodes and
- building the full iname path ('local.foo.bar') that is required for
- GDBMI dumping. The full name depends on the path on which a node was reached
+ \brief The SymbolGroupNodeVisitor class is a visitor that iterates over the
+ nodes and builds the full iname path ('local.foo.bar') that is required for
+ GDBMI dumping.
+
+ The full name depends on the path on which a node was reached
for referenced nodes (a linked list element can be reached via array index
or by expanding the whole structure).
visit() is not called for the (invisible) root node, but starting with the
@@ -1578,7 +1589,7 @@ std::string SymbolGroupNodeVisitor::parentIname(const std::string &iname)
}
/*! \class DebugSymbolGroupNodeVisitor
- \brief Debug output visitor.
+ \brief The DebugSymbolGroupNodeVisitor class is a debug output visitor.
\ingroup qtcreatorcdbext
*/
@@ -1597,7 +1608,8 @@ SymbolGroupNodeVisitor::VisitResult
}
/*! \class DebugFilterSymbolGroupNodeVisitor
- \brief Debug filtering output visitor.
+ \brief The DebugFilterSymbolGroupNodeVisitor class is a debug filtering
+ output visitor.
\ingroup qtcreatorcdbext
*/
@@ -1620,9 +1632,9 @@ SymbolGroupNodeVisitor::VisitResult
}
/*! \class DumpSymbolGroupNodeVisitor
-
- GDBMI dump output visitor used to report locals values back to the
- debugging engine. \ingroup qtcreatorcdbext
+ \brief The DumpSymbolGroupNodeVisitor class is a GDBMI dump output visitor
+ used to report locals values back to the debugging engine.
+ \ingroup qtcreatorcdbext
*/
DumpSymbolGroupNodeVisitor::DumpSymbolGroupNodeVisitor(std::ostream &os,
diff --git a/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp b/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp
index 66fc986e82e00331bc94c4b80c04522e96c85d73..2a1200a953f955121a83628889e9c28448d2c044 100644
--- a/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp
+++ b/src/libs/qtcreatorcdbext/symbolgroupvalue.cpp
@@ -47,15 +47,18 @@
typedef std::vector<int>::size_type VectorIndexType;
-/*! \struct SymbolGroupValueContext
- \brief Structure to pass all IDebug interfaces required for SymbolGroupValue
+/*!
+ \class SymbolGroupValueContext
+ \brief The SymbolGroupValueContext class passes all IDebug interfaces
+ required for SymbolGroupValue.
\ingroup qtcreatorcdbext */
/*! \class SymbolGroupValue
- Flyweight tied to a SymbolGroupNode
+ \brief The SymbolGroupValue class is a flyweight tied to a SymbolGroupNode
providing a convenient operator[] (name, index) and value
getters for notation of dumpers.
+
Inaccessible members return a SymbolGroupValue in state 'invalid'.
Example:
\code
@@ -681,9 +684,12 @@ static inline std::string resolveQtSymbol(const char *symbolC,
return rc;
}
-/*! \struct QtInfo
+/*!
+ \class QtInfo
+
+ \brief The QtInfo class provides Qt information determined on demand.
- Qt Information determined on demand: Namespace, modules and basic class
+ Namespace, modules, and basic class
names containing the module for fast lookup.
\ingroup qtcreatorcdbext */
diff --git a/src/libs/ssh/sftpchannel.cpp b/src/libs/ssh/sftpchannel.cpp
index 3bad75df91dd1518afdf25c30d5e737f9409ff32..94ce5578b6f4a3707fea11004ac4ea23161b380a 100644
--- a/src/libs/ssh/sftpchannel.cpp
+++ b/src/libs/ssh/sftpchannel.cpp
@@ -40,7 +40,7 @@
/*!
\class QSsh::SftpChannel
- \brief This class provides SFTP operations.
+ \brief The SftpChannel class provides SFTP operations.
Objects are created via SshConnection::createSftpChannel().
The channel needs to be initialized with
diff --git a/src/libs/ssh/sshconnection.cpp b/src/libs/ssh/sshconnection.cpp
index 7d5ca7b584785a5e2be526721e514d59432d542d..221025f1e92eb60fbfbd3aeb39f42360027a88a2 100644
--- a/src/libs/ssh/sshconnection.cpp
+++ b/src/libs/ssh/sshconnection.cpp
@@ -51,7 +51,8 @@
/*!
\class QSsh::SshConnection
- \brief This class provides an SSH connection, implementing protocol version 2.0
+ \brief The SshConnection class provides an SSH connection, implementing
+ protocol version 2.0.
It can spawn channels for remote execution and SFTP operations (version 3).
It operates asynchronously (non-blocking) and is not thread-safe.
diff --git a/src/libs/ssh/sshremoteprocess.cpp b/src/libs/ssh/sshremoteprocess.cpp
index f3b58df76df5ce47ae58807617a8939796678882..ec40f9c6f39cce2be24596a0f0c0081bbb8ed482 100644
--- a/src/libs/ssh/sshremoteprocess.cpp
+++ b/src/libs/ssh/sshremoteprocess.cpp
@@ -43,7 +43,8 @@
/*!
\class QSsh::SshRemoteProcess
- \brief This class implements an SSH channel for running a remote process.
+ \brief The SshRemoteProcess class implements an SSH channel for running a
+ remote process.
Objects are created via SshConnection::createRemoteProcess.
The process is started via the start() member function.
diff --git a/src/libs/ssh/sshremoteprocessrunner.cpp b/src/libs/ssh/sshremoteprocessrunner.cpp
index 768ae71ac7594466a0144312aee2c8304ff6e477..159f5e9f77d5ca817e21e2930abc8333b86391b6 100644
--- a/src/libs/ssh/sshremoteprocessrunner.cpp
+++ b/src/libs/ssh/sshremoteprocessrunner.cpp
@@ -36,7 +36,8 @@
/*!
\class QSsh::SshRemoteProcessRunner
- \brief Convenience class for running a remote process over an SSH connection.
+ \brief The SshRemoteProcessRunner class is a convenience class for
+ running a remote process over an SSH connection.
*/
namespace QSsh {
diff --git a/src/libs/utils/basevalidatinglineedit.cpp b/src/libs/utils/basevalidatinglineedit.cpp
index b5b81fc1ed118651bad3dec62b476e39f9694747..00d16d255862802ee701c742422017bbf44de36d 100644
--- a/src/libs/utils/basevalidatinglineedit.cpp
+++ b/src/libs/utils/basevalidatinglineedit.cpp
@@ -40,7 +40,8 @@ enum { debug = 0 };
/*! \class Utils::BaseValidatingLineEdit
- \brief Base class for line edits that perform validation.
+ \brief The BaseValidatingLineEdit class is the base class for line edits
+ that perform validation.
Performs validation in a virtual validate() function to be implemented in
derived classes.
diff --git a/src/libs/utils/bracematcher.cpp b/src/libs/utils/bracematcher.cpp
index 297ca564a341b2e68cb927384ea0810a73ab0def..770c045e8668c2691e48466898d545513da220e0 100644
--- a/src/libs/utils/bracematcher.cpp
+++ b/src/libs/utils/bracematcher.cpp
@@ -34,7 +34,8 @@
/*!
\class Utils::BraceMatcher
- \brief Generic autocompleter of braces and quotes.
+ \brief The BraceMatcher class implements a generic autocompleter of braces
+ and quotes.
This is a helper class for autocompleter implementations. To use it,
define "brace", "quote", and "delimiter" characters for given language.
diff --git a/src/libs/utils/checkablemessagebox.cpp b/src/libs/utils/checkablemessagebox.cpp
index ffed23c0cb4f15e103c1d70eb2319de8a8ad0b4b..5b455e19d9d49c818a5b6e773205b05d30fc517a 100644
--- a/src/libs/utils/checkablemessagebox.cpp
+++ b/src/libs/utils/checkablemessagebox.cpp
@@ -38,7 +38,8 @@
/*!
\class Utils::CheckableMessageBox
- \brief A messagebox suitable for questions with a
+ \brief The CheckableMessageBox class implements a message box suitable for
+ questions with a
"Do not ask me again" checkbox.
Emulates the QMessageBox API with
diff --git a/src/libs/utils/classnamevalidatinglineedit.cpp b/src/libs/utils/classnamevalidatinglineedit.cpp
index 4ebf220a7cb5a5d22ff418ead873f6dcfca54f61..6199d531bc367bdf148d1ce7bf9ba40354ec5650 100644
--- a/src/libs/utils/classnamevalidatinglineedit.cpp
+++ b/src/libs/utils/classnamevalidatinglineedit.cpp
@@ -37,7 +37,8 @@
/*!
\class Utils::ClassNameValidatingLineEdit
- \brief A Line edit that validates a C++ class name and emits a signal
+ \brief The ClassNameValidatingLineEdit class implements a line edit that
+ validates a C++ class name and emits a signal
to derive suggested file names from it.
*/
diff --git a/src/libs/utils/completingtextedit.cpp b/src/libs/utils/completingtextedit.cpp
index 316e819f7fa98f12d50d134982c8187711a1bed9..f32dcbbf88d09575e14c07c06bd3e1dca59536a5 100644
--- a/src/libs/utils/completingtextedit.cpp
+++ b/src/libs/utils/completingtextedit.cpp
@@ -41,7 +41,8 @@ static bool isEndOfWordChar(const QChar &c)
/*! \class Utils::CompletingTextEdit
- \brief A QTextEdit with auto-completion support
+ \brief The CompletingTextEdit class is a QTextEdit with auto-completion
+ support.
Excerpted from Qt examples/tools/customcompleter
*/
diff --git a/src/libs/utils/detailswidget.cpp b/src/libs/utils/detailswidget.cpp
index 91ecd22e2986c29c4090b21b00931f8b4414e187..32d54c18cba9820d91afbc868a032223b524d38b 100644
--- a/src/libs/utils/detailswidget.cpp
+++ b/src/libs/utils/detailswidget.cpp
@@ -41,7 +41,8 @@
/*!
\class Utils::DetailsWidget
- \brief Widget a button to expand a 'Details' area.
+ \brief The DetailsWidget class implements a button to expand a \e Details
+ area.
This widget is using a grid layout and places the items
in the following way:
diff --git a/src/libs/utils/elidinglabel.cpp b/src/libs/utils/elidinglabel.cpp
index fd01545ed7399beeb4f1f391a4f34578b5d53506..7fda2539078ba0669c6047ec3bc29bc040ac03ac 100644
--- a/src/libs/utils/elidinglabel.cpp
+++ b/src/libs/utils/elidinglabel.cpp
@@ -35,7 +35,8 @@
/*!
\class Utils::ElidingLabel
- \brief A label suitable for displaying elided text.
+ \brief The ElidingLabel class is a label suitable for displaying elided
+ text.
*/
namespace Utils {
diff --git a/src/libs/utils/faketooltip.cpp b/src/libs/utils/faketooltip.cpp
index c0f45e7e2d805fdb7aa8a4163ac2a1e90c77b389..693dd33ea880e3972a4bbaf9b06a273f02a1b550 100644
--- a/src/libs/utils/faketooltip.cpp
+++ b/src/libs/utils/faketooltip.cpp
@@ -35,7 +35,7 @@
/*!
\class Utils::FakeToolTip
- \brief A widget that pretends to be a tooltip.
+ \brief The FakeToolTip class is a widget that pretends to be a tooltip.
By default it has Qt::WA_DeleteOnClose set.
*/
diff --git a/src/libs/utils/fancylineedit.cpp b/src/libs/utils/fancylineedit.cpp
index 6456af90424549fa5f65069dc2d986b26f56c6ed..489d3022ce5afa640c096bbe6cbf6b06b20f61c8 100644
--- a/src/libs/utils/fancylineedit.cpp
+++ b/src/libs/utils/fancylineedit.cpp
@@ -72,7 +72,8 @@ static void execMenuAtWidget(QMenu *menu, QWidget *widget)
/*!
\class Utils::FancyLineEdit
- \brief A line edit with an embedded pixmap on one side that is connected to
+ \brief The FancyLineEdit class is a line edit with an embedded pixmap on
+ one side that is connected to
a menu.
Additionally, it can display a grayed hintText (like "Type Here to")
diff --git a/src/libs/utils/fancymainwindow.cpp b/src/libs/utils/fancymainwindow.cpp
index 6b90dce13c3608ef0938ea9ac7806f8e39f82f2e..2c3dd06cf0928a00be067b1d6e2fa920305d4336 100644
--- a/src/libs/utils/fancymainwindow.cpp
+++ b/src/libs/utils/fancymainwindow.cpp
@@ -45,7 +45,8 @@ namespace Utils {
/*! \class Utils::FancyMainWindow
- \brief MainWindow with dock widgets and additional "lock" functionality
+ \brief The FancyMainWindow class is a MainWindow with dock widgets and
+ additional "lock" functionality
(locking the dock widgets in place) and "reset layout" functionality.
The dock actions and the additional actions should be accessible
diff --git a/src/libs/utils/fileinprojectfinder.cpp b/src/libs/utils/fileinprojectfinder.cpp
index d4fe24e6e88532486115cdc053512facd198634c..fbf3d751e71db7a8114157c94fe8242a7354ce0f 100644
--- a/src/libs/utils/fileinprojectfinder.cpp
+++ b/src/libs/utils/fileinprojectfinder.cpp
@@ -41,7 +41,8 @@ namespace Utils {
/*!
\class Utils::FileInProjectFinder
- \brief Helper class to find the 'original' file in the project directory for a given file url.
+ \brief The FileInProjectFinder class is a helper class to find the \e original
+ file in the project directory for a given file URL.
Often files are copied in the build + deploy process. findFile() searches for an existing file
in the project directory for a given file path:
diff --git a/src/libs/utils/filenamevalidatinglineedit.cpp b/src/libs/utils/filenamevalidatinglineedit.cpp
index 6fa95eac7483aec53033668d48e539d546775100..55752785d682d79354f172e73b6b3e10199f729a 100644
--- a/src/libs/utils/filenamevalidatinglineedit.cpp
+++ b/src/libs/utils/filenamevalidatinglineedit.cpp
@@ -36,7 +36,10 @@
/*!
\class Utils::FileNameValidatingLineEdit
- \brief A control that let's the user choose a (base) file name, based on a QLineEdit. Has
+ \brief The FileNameValidatingLineEdit class is a control that lets the user
+ choose a (base) file name, based on a QLineEdit.
+
+ The class has
some validation logic for embedding into QWizardPage.
*/
diff --git a/src/libs/utils/filesystemwatcher.cpp b/src/libs/utils/filesystemwatcher.cpp
index 5d3f354023605ca86beca623685a05fc64f1b0bb..2811f8c249c1cd423ff1a66fbaff1c198c6e6db6 100644
--- a/src/libs/utils/filesystemwatcher.cpp
+++ b/src/libs/utils/filesystemwatcher.cpp
@@ -52,7 +52,8 @@ static inline quint64 getFileLimit()
/*!
\class Utils::FileSystemWatcher
- \brief File watcher that internally uses a centralized QFileSystemWatcher
+ \brief The FileSystemWatcher class is a file watcher that internally uses
+ a centralized QFileSystemWatcher
and enforces limits on Mac OS.
\section1 Design Considerations
diff --git a/src/libs/utils/fileutils.cpp b/src/libs/utils/fileutils.cpp
index 06b8936e825ea932352fdde56b92e4d35398f46c..f39e5b4751193b76f16955ff399a6280cba36af3 100644
--- a/src/libs/utils/fileutils.cpp
+++ b/src/libs/utils/fileutils.cpp
@@ -42,9 +42,9 @@ namespace Utils {
/*! \class Utils::FileUtils
- \brief File- and directory-related convenience functions.
+ \brief The FileUtils class contains file and directory related convenience
+ functions.
- File- and directory-related convenience functions.
*/
/*!
@@ -411,7 +411,7 @@ TempFileSaver::~TempFileSaver()
/*! \class Utils::FileName
- \brief A light-weight convenience class for filenames
+ \brief The FileName class is a light-weight convenience class for filenames.
On windows filenames are compared case insensitively.
*/
diff --git a/src/libs/utils/filewizarddialog.cpp b/src/libs/utils/filewizarddialog.cpp
index 72d63c384211ed4ce32df3be6c67b7ffaeb50c72..483fb7e400e6b2b28f029e8b200c1c7bf4697740 100644
--- a/src/libs/utils/filewizarddialog.cpp
+++ b/src/libs/utils/filewizarddialog.cpp
@@ -37,8 +37,10 @@
/*!
\class Utils::FileWizardDialog
- \brief Standard wizard for a single file letting the user choose name
- and path. Custom pages can be added via Core::IWizardExtension.
+ \brief The FileWizardDialog class is a standard wizard for a single file
+ letting the user choose name and path.
+
+ Custom pages can be added via Core::IWizardExtension.
*/
namespace Utils {
diff --git a/src/libs/utils/filewizardpage.cpp b/src/libs/utils/filewizardpage.cpp
index 5958e9de82e94b794be2a5d900e6612a087657d2..0f0852076edf6a2da8f43675180f66517ab426e1 100644
--- a/src/libs/utils/filewizardpage.cpp
+++ b/src/libs/utils/filewizardpage.cpp
@@ -33,7 +33,8 @@
/*!
\class Utils::FileWizardPage
- \brief Standard wizard page for a single file letting the user choose name
+ \brief The FileWizardPage class is a standard wizard page for a single file
+ letting the user choose name
and path.
The name and path labels can be changed. By default they are simply "Name:"
diff --git a/src/libs/utils/filterlineedit.cpp b/src/libs/utils/filterlineedit.cpp
index 5c61b25a6b2779cb8f35befd73799de503c08585..a60dbe7878f54101a1cc4f3d499365d091fe510d 100644
--- a/src/libs/utils/filterlineedit.cpp
+++ b/src/libs/utils/filterlineedit.cpp
@@ -32,7 +32,8 @@
/*!
\class Utils::FilterLineEdit
- \brief A fancy line edit customized for filtering purposes with a clear button.
+ \brief The FilterLineEdit class is a fancy line edit customized for
+ filtering purposes with a clear button.
*/
namespace Utils {
diff --git a/src/libs/utils/headerviewstretcher.cpp b/src/libs/utils/headerviewstretcher.cpp
index 5bd975a491ca8d90db763e9fd2bc213dccfc6825..c42e3c1911916afed088ce13f27169cfcae887a2 100644
--- a/src/libs/utils/headerviewstretcher.cpp
+++ b/src/libs/utils/headerviewstretcher.cpp
@@ -37,7 +37,8 @@ using namespace Utils;
/*!
\class Utils::HeaderViewStretcher
- \brief The class fixes QHeaderView to resize all columns to contents, except one
+ \brief The HeaderViewStretcher class fixes QHeaderView to resize all
+ columns to contents, except one
stretching column.
As opposed to standard QTreeWidget, all columns are
diff --git a/src/libs/utils/ipaddresslineedit.cpp b/src/libs/utils/ipaddresslineedit.cpp
index 115f276ad7a27adb080dbc0688030d7f5fa9c34e..f74a2c3e3ea1a548edce2fa9ece8084a22b6f8d4 100644
--- a/src/libs/utils/ipaddresslineedit.cpp
+++ b/src/libs/utils/ipaddresslineedit.cpp
@@ -34,7 +34,8 @@
/*!
\class Utils::IpAddressLineEdit
- \brief A QLineEdit widget that validates the IP address inserted.
+ \brief The IpAddressLineEdit class is a QLineEdit widget that validates the
+ IP address inserted.
The valid address example is 192.168.1.12 or 192.168.1.12:8080.
*/
diff --git a/src/libs/utils/linecolumnlabel.cpp b/src/libs/utils/linecolumnlabel.cpp
index cb0eb66146f442bf06e4656590aee02a3d58fec2..50049b5573ce52c6e17cb30bfc41eb760f4f14f2 100644
--- a/src/libs/utils/linecolumnlabel.cpp
+++ b/src/libs/utils/linecolumnlabel.cpp
@@ -34,7 +34,8 @@
/*!
\class Utils::LineColumnLabel
- \brief A label suitable for displaying cursor positions, etc. with a fixed
+ \brief The LineColumnLabel class is a label suitable for displaying cursor
+ positions, and so on, with a fixed
width derived from a sample text.
*/
diff --git a/src/libs/utils/navigationtreeview.cpp b/src/libs/utils/navigationtreeview.cpp
index b98849b91a97a89e5cfbeacc29c2f5bc7ee515fd..cdf6d3b4d69655545e8df309a7fc46ef5fb4ce8a 100644
--- a/src/libs/utils/navigationtreeview.cpp
+++ b/src/libs/utils/navigationtreeview.cpp
@@ -39,7 +39,8 @@
/*!
\class Utils::NavigationTreeView
- \brief General TreeView for any Side Bar widget.
+ \brief The NavigationTreeView class implements a general TreeView for any
+ sidebar widget.
Common initialization etc, e.g. Mac specific behaviour.
\sa Core::NavigationView, Core::INavigationWidgetFactory
diff --git a/src/libs/utils/networkaccessmanager.cpp b/src/libs/utils/networkaccessmanager.cpp
index 8915275fe3e2daf0caf35a4e7e4366d648192b2b..68f48420dffc95d30523d2b38dd64a4b325360eb 100644
--- a/src/libs/utils/networkaccessmanager.cpp
+++ b/src/libs/utils/networkaccessmanager.cpp
@@ -40,7 +40,8 @@
/*!
\class Utils::NetworkManager
- \brief Network Access Manager for use with Qt Creator.
+ \brief The NetworkManager class provides a network access manager for use
+ with \QC.
Common initialization, Qt Creator User Agent
diff --git a/src/libs/utils/newclasswidget.cpp b/src/libs/utils/newclasswidget.cpp
index 46b4892463e5852c7370374f62cc652389f18c6c..df048c6525684d8d318121df275a112c9fd16aaa 100644
--- a/src/libs/utils/newclasswidget.cpp
+++ b/src/libs/utils/newclasswidget.cpp
@@ -39,9 +39,9 @@ enum { debugNewClassWidget = 0 };
/*! \class Utils::NewClassWidget
- \brief Utility widget for 'New Class' wizards
+ \brief The NewClassWidget class is a utility widget for 'New Class' wizards.
- Utility widget for 'New Class' wizards. Prompts the user
+ This widget prompts the user
to enter a class name (optionally derived from some base class) and file
names for header, source and form files. Has some smart logic to derive
the file names from the class name. */
diff --git a/src/libs/utils/parameteraction.cpp b/src/libs/utils/parameteraction.cpp
index 1d44a2fc390d495e918ac0f37b3546c89696fa13..96a51cc0ebda758104e80f0c6ab43228fda7f357 100644
--- a/src/libs/utils/parameteraction.cpp
+++ b/src/libs/utils/parameteraction.cpp
@@ -32,7 +32,7 @@
/*!
\class Utils::ParameterAction
- \brief Intended for actions that act on a 'current',
+ \brief The ParameterAction class is intended for actions that act on a 'current',
string-type parameter (typically a file name), for example 'Save file %1'.
The action has 2 states:
diff --git a/src/libs/utils/pathchooser.cpp b/src/libs/utils/pathchooser.cpp
index 2464e7df0387c7ba44f8fdea1e20780044f0f1a2..ea60dd770d5c2dec811bb24df30605bd149edd37 100644
--- a/src/libs/utils/pathchooser.cpp
+++ b/src/libs/utils/pathchooser.cpp
@@ -46,7 +46,8 @@
/*!
\class Utils::PathChooser
- \brief A control that let's the user choose a path, consisting of a QLineEdit and
+ \brief The PathChooser class is a control that lets the user choose a path,
+ consisting of a QLineEdit and
a "Browse" button.
Has some validation logic for embedding into QWizardPage.
diff --git a/src/libs/utils/pathlisteditor.cpp b/src/libs/utils/pathlisteditor.cpp
index 7bd9c70010c17e0dc9613344b7e2244bc06312c7..f213afda17871b5e77312bb7b2ffd4238ac9a694 100644
--- a/src/libs/utils/pathlisteditor.cpp
+++ b/src/libs/utils/pathlisteditor.cpp
@@ -46,7 +46,8 @@
/*!
\class Utils::PathListEditor
- \brief A control that let's the user edit a list of (directory) paths
+ \brief The PathListEditor class is a control that lets the user edit a list
+ of (directory) paths
using the platform separator (';',':').
Typically used for
diff --git a/src/libs/utils/persistentsettings.cpp b/src/libs/utils/persistentsettings.cpp
index 2acf1927d9b104e234ed35c69ddf7690593311cd..406088032483b04bcf98e167eb43200adb5e3e1d 100644
--- a/src/libs/utils/persistentsettings.cpp
+++ b/src/libs/utils/persistentsettings.cpp
@@ -43,7 +43,8 @@
/*!
\class Utils::PersistentSettingsReader
- \brief Reads a QVariantMap of arbitrary, nested data structures from a XML file.
+ \brief The PersistentSettingsReader class reads a QVariantMap of arbitrary,
+ nested data structures from an XML file.
Handles all string-serializable simple types and QVariantList and QVariantMap. Example:
\code
@@ -321,7 +322,8 @@ bool PersistentSettingsReader::load(const Utils::FileName &fileName)
/*!
\class Utils::PersistentSettingsWriter
- \brief Serializes a QVariantMap of arbitrary, nested data structures to a XML file.
+ \brief The PersistentSettingsWriter class serializes a QVariantMap of
+ arbitrary, nested data structures to an XML file.
\sa Utils::PersistentSettingsReader
*/
diff --git a/src/libs/utils/projectintropage.cpp b/src/libs/utils/projectintropage.cpp
index 5755d0b25138cc358f9394320a0522d3d67feaa0..2e02f04cfaa60ac60958696e8a2f359fa46c7e89 100644
--- a/src/libs/utils/projectintropage.cpp
+++ b/src/libs/utils/projectintropage.cpp
@@ -35,7 +35,8 @@
/*!
\class Utils::ProjectIntroPage
- \brief Standard wizard page for a project, letting the user choose name
+ \brief The ProjectIntroPage class is the standard wizard page for a project,
+ letting the user choose its name
and path.
Looks similar to FileWizardPage, but provides additional
diff --git a/src/libs/utils/qtcprocess.cpp b/src/libs/utils/qtcprocess.cpp
index 11da30f822f0a227c6cf9b413d5d1700978f819c..1666d28318eea9be2a06eb957b13f6b47d563868 100644
--- a/src/libs/utils/qtcprocess.cpp
+++ b/src/libs/utils/qtcprocess.cpp
@@ -45,7 +45,8 @@ using namespace Utils;
/*!
\class Utils::QtcProcess
- \brief This class provides functionality for dealing with shell-quoted process arguments.
+ \brief The QtcProcess class provides functionality for dealing with
+ shell-quoted process arguments.
*/
#ifdef Q_OS_WIN
diff --git a/src/libs/utils/statuslabel.cpp b/src/libs/utils/statuslabel.cpp
index 5a7a25f51479f24856edb07a206e085a5c660d81..ed8646ed3251f6083f7144c3a1bf4ffa4a2e60cd 100644
--- a/src/libs/utils/statuslabel.cpp
+++ b/src/libs/utils/statuslabel.cpp
@@ -34,7 +34,7 @@
/*!
\class Utils::StatusLabel
- \brief A status label that displays messages for a while with a timeout.
+ \brief The StatusLabel class displays messages for a while with a timeout.
*/
namespace Utils {
diff --git a/src/libs/utils/synchronousprocess.cpp b/src/libs/utils/synchronousprocess.cpp
index 1d68bc41d747da0106422f60c4e267c7c18d637b..d744e28f98551f937a056f29835ab88fb9eab4fa 100644
--- a/src/libs/utils/synchronousprocess.cpp
+++ b/src/libs/utils/synchronousprocess.cpp
@@ -48,8 +48,8 @@
/*!
\class Utils::SynchronousProcess
- \brief Runs a synchronous process in its own event loop
- that blocks only user input events. Thus, it allows for the gui to
+ \brief The SynchronousProcess class runs a synchronous process in its own
+ event loop that blocks only user input events. Thus, it allows for the GUI to
repaint and append output to log windows.
The stdOut(), stdErr() signals are emitted unbuffered as the process
diff --git a/src/libs/utils/tcpportsgatherer.cpp b/src/libs/utils/tcpportsgatherer.cpp
index 84eea9e5965123e3e3358dbcd4d01eea335b6dd6..0f56da91e64b7a809d606cb1aff60fab4318ceef 100644
--- a/src/libs/utils/tcpportsgatherer.cpp
+++ b/src/libs/utils/tcpportsgatherer.cpp
@@ -247,7 +247,8 @@ void TcpPortsGathererPrivate::updateNetstat()
/*!
\class Utils::TcpPortsGatherer
- \brief Gather the list of local TCP ports already in use.
+ \brief The TcpPortsGatherer class gathers the list of local TCP ports
+ already in use.
Query the system for the list of local TCP ports already in use. This information can be used
to select a port for use in a range.
diff --git a/src/libs/utils/textfileformat.cpp b/src/libs/utils/textfileformat.cpp
index 62f22bb964eb995544f389f1abd3ad3a6125ac3a..df657b7803be94d67ce583b87963b814ce8db95e 100644
--- a/src/libs/utils/textfileformat.cpp
+++ b/src/libs/utils/textfileformat.cpp
@@ -58,7 +58,8 @@ QDebug operator<<(QDebug d, const TextFileFormat &format)
/*!
\class Utils::TextFileFormat
- \brief Describes the format of a text file and provides autodetection.
+ \brief The TextFileFormat class describes the format of a text file and
+ provides autodetection.
The format comprises
\list
diff --git a/src/libs/utils/wizard.cpp b/src/libs/utils/wizard.cpp
index 860c69e78f26d79aa123ec06587c0907601d0766..743c628de9b91e9e5c70ad2ff4b718daadf6b78d 100644
--- a/src/libs/utils/wizard.cpp
+++ b/src/libs/utils/wizard.cpp
@@ -38,7 +38,7 @@
/*! \class Utils::Wizard
- \brief A wizard with a progress bar on the left.
+ \brief The Wizard class implements a wizard with a progress bar on the left.
Informs the user about the progress.
*/
diff --git a/src/libs/zeroconf/servicebrowser.cpp b/src/libs/zeroconf/servicebrowser.cpp
index b1e8eebfb505de944ce9cc433f1b0bb1507c5bc3..f41a3f3bbbe498ad6e399c6d145047e2b278c130 100644
--- a/src/libs/zeroconf/servicebrowser.cpp
+++ b/src/libs/zeroconf/servicebrowser.cpp
@@ -68,7 +68,8 @@ typedef long suseconds_t;
/*!
\namespace ZeroConf
- \brief namespace for zeroconf (Bonjour/DNS-SD) functionality, currently mostly for browsing services.
+ \brief The ZeroConf namespace provides zeroconf (Bonjour/DNS-SD)
+ functionality, currently mostly for browsing services.
*/
namespace { // anonymous namespace for free functions
@@ -220,9 +221,8 @@ int gQuickStop = 0;
/*!
\class ZeroConf::ErrorMessage
- \brief class representing an error message
+ \brief The ErrorMessage class represents an error message.
- very simple class representing an error message
*/
/// empty constructor (required by qRegisterMetaType)
@@ -258,7 +258,7 @@ QDebug operator<<(QDebug dbg, const ErrorMessage &eMsg)
/*!
\class ZeroConf::Service
- \brief class representing a zeroconf service
+ \brief The Service class represents a zeroconf service.
Instances of this class are basically constant, but can be outdated. They are normally accessed
through a Shared pointer.
@@ -448,7 +448,8 @@ QDebug operator<<(QDebug dbg, const Service::ConstPtr &service){
/*!
\class ZeroConf::ServiceBrowser
- \brief class that browses (searches) for a given zeronconf service
+ \brief The ServiceBrowser class browses (searches) for a given zeronconf
+ service.
The actual browsing starts only when startBrowsing() is called. If you want to receive all service
changes connect before starting browsing.
diff --git a/src/plugins/bineditor/bineditorplugin.cpp b/src/plugins/bineditor/bineditorplugin.cpp
index dbfd7e219e476b18651239ca0b9e29a71675e81e..1d060401433a6fcacb4e51106ca0a49f1b6dca96 100644
--- a/src/plugins/bineditor/bineditorplugin.cpp
+++ b/src/plugins/bineditor/bineditorplugin.cpp
@@ -428,7 +428,8 @@ QStringList BinEditorFactory::mimeTypes() const
/*!
\class BINEditor::BinEditorWidgetFactory
- \brief Service registered with PluginManager to create bin editor widgets for plugins
+ \brief The BinEditorWidgetFactory class offers a service registered with
+ PluginManager to create bin editor widgets for plugins
without direct linkage.
\sa ExtensionSystem::PluginManager::getObjectByClassName, ExtensionSystem::invoke
diff --git a/src/plugins/coreplugin/actionmanager/actionmanager.cpp b/src/plugins/coreplugin/actionmanager/actionmanager.cpp
index b9d11a1f56265e8282c23638b1d8e2fa9479bfe2..d4ed4f784049d06a8c1a6ddca1dba337fd433e5e 100644
--- a/src/plugins/coreplugin/actionmanager/actionmanager.cpp
+++ b/src/plugins/coreplugin/actionmanager/actionmanager.cpp
@@ -55,7 +55,7 @@ using namespace Core::Internal;
\class Core::ActionManager
\mainclass
- \brief The action manager is responsible for registration of menus and
+ \brief The ActionManager class is responsible for registration of menus and
menu items and keyboard shortcuts.
The ActionManager is the central bookkeeper of actions and their shortcuts and layout.
diff --git a/src/plugins/coreplugin/actionmanager/commandbutton.cpp b/src/plugins/coreplugin/actionmanager/commandbutton.cpp
index 7176751112ab454d2a6bb7a2442f760b4ba88b5a..7f5917aa8b495369e5c8d5f25d2a6d97d9e6b2fa 100644
--- a/src/plugins/coreplugin/actionmanager/commandbutton.cpp
+++ b/src/plugins/coreplugin/actionmanager/commandbutton.cpp
@@ -37,7 +37,8 @@ using namespace Core;
/*!
\class Core::CommandButton
- \brief A tool button associated with one of registered Command objects.
+ \brief The CommandButton class is a tool button associated with one of
+ the registered Command objects.
Tooltip of this button consists of toolTipBase property value and Command's
key sequence which is automatically updated when user changes it.
diff --git a/src/plugins/coreplugin/basefilewizard.cpp b/src/plugins/coreplugin/basefilewizard.cpp
index d0c9d91718f624041dd06571c52a4dde18df3995..74d49cef3660a8d9f08dbd57df573bd88523e0e5 100644
--- a/src/plugins/coreplugin/basefilewizard.cpp
+++ b/src/plugins/coreplugin/basefilewizard.cpp
@@ -100,8 +100,9 @@ void BaseFileWizardParameterData::clear()
/*!
\class Core::BaseFileWizardParameters
- \brief Parameter class for passing parameters to instances of class Wizard
- containing name, icon and such.
+ \brief The BaseFileWizardParameters class is a parameter class for
+ passing parameters to instances of the class Wizard containing name, icon,
+ and so on.
\sa Core::GeneratedFile, Core::BaseFileWizard, Core::StandardFileWizard
\sa Core::Internal::WizardEventLoop
@@ -341,7 +342,8 @@ void WizardEventLoop::rejected()
/*!
\class Core::BaseFileWizard
- \brief A generic wizard for creating files.
+ \brief The BaseFileWizard class implements a generic wizard for
+ creating files.
The abstract methods:
\list
@@ -781,7 +783,8 @@ QString BaseFileWizard::preferredSuffix(const QString &mimeType)
/*!
\class Core::StandardFileWizard
- \brief Convenience class for creating one file.
+ \brief The StandardFileWizard class is a convenience class for
+ creating one file.
It uses Utils::FileWizardDialog and introduces a new virtual to generate the
files from path and name.
diff --git a/src/plugins/coreplugin/dialogs/ioptionspage.cpp b/src/plugins/coreplugin/dialogs/ioptionspage.cpp
index db3b8006ca663402553068ddf3a1fc378f57dc0e..34f1de78a2f6979173af91de8150e4adb6bc24d6 100644
--- a/src/plugins/coreplugin/dialogs/ioptionspage.cpp
+++ b/src/plugins/coreplugin/dialogs/ioptionspage.cpp
@@ -32,7 +32,8 @@
/*!
\class Core::IOptionsPage
\mainclass
- \brief The IOptionsPage is an interface for providing options pages.
+ \brief The IOptionsPage class is an interface for providing pages for the
+ \gui Options dialog (called \gui Preferences on Mac OS).
You need to subclass this interface and put an instance of your subclass
into the plugin manager object pool (e.g. ExtensionSystem::PluginManager::addObject).
diff --git a/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp b/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp
index 9ec8fd9f3d51bdf227300cbe2fcee84e0f4fca9a..bdde354b96723f39d12febec3dc6304098c7b9c8 100644
--- a/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp
+++ b/src/plugins/coreplugin/dialogs/promptoverwritedialog.cpp
@@ -44,9 +44,11 @@ enum { FileNameRole = Qt::UserRole + 1 };
/*!
\class Core::Internal::PromptOverwriteDialog
- \brief Prompts the user to overwrite a list of files, which he can check.
+ \brief The PromptOverwriteDialog class implements a dialog that asks
+ users whether they want to overwrite files.
- Displays the common folder and the files in a checkable list.
+ The dialog displays the common folder and the files in a list where users
+ can select the files to overwrite.
*/
static inline QString fileNameOfItem(const QStandardItem *item)
diff --git a/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp b/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp
index 66d86e973ae51d95ed88cef0cd348dda730cbd50..18d1e0f10f8e65dd6215d9fa4b914e89f26d989e 100644
--- a/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp
+++ b/src/plugins/coreplugin/dialogs/readonlyfilesdialog.cpp
@@ -106,7 +106,8 @@ ReadOnlyFilesDialogPrivate::~ReadOnlyFilesDialogPrivate()
/*!
* \class ReadOnlyFilesDialog
- * \brief Dialog to show a set of files which are classified as not writable.
+ * \brief The ReadOnlyFilesDialog class implements a dialog to show a set of
+ * files that are classified as not writable.
*
* Automatically checks which operations are allowed to make the file writable. These operations
* are Make Writable which tries to set the file permissions in the file system,
diff --git a/src/plugins/coreplugin/documentmanager.cpp b/src/plugins/coreplugin/documentmanager.cpp
index 540e2fa7d2baf1be8f0acf47f1cad4caaa24522d..b39861600c8655fb7a2cb38f05d32ac5bc1f3e14 100644
--- a/src/plugins/coreplugin/documentmanager.cpp
+++ b/src/plugins/coreplugin/documentmanager.cpp
@@ -64,7 +64,7 @@
\class Core::DocumentManager
\mainclass
\inheaderfile documentmanager.h
- \brief Manages a set of IDocument objects.
+ \brief The DocumentManager class manages a set of IDocument objects.
The DocumentManager service monitors a set of IDocument's. Plugins should register
files they work with at the service. The files the IDocument's point to will be
diff --git a/src/plugins/coreplugin/editormanager/ieditor.cpp b/src/plugins/coreplugin/editormanager/ieditor.cpp
index d9ad75fe8e7602239dc6e000308671f171c138ef..45ed5897df766fbb450bee1c4daa486c7c316649 100644
--- a/src/plugins/coreplugin/editormanager/ieditor.cpp
+++ b/src/plugins/coreplugin/editormanager/ieditor.cpp
@@ -31,7 +31,8 @@
/*!
\class Core::IEditor
- \brief The IEditor is an interface for providing different editors for different file types.
+ \brief The IEditor class is an interface for providing different editors for
+ different file types.
Classes that implement this interface are for example the editors for
C++ files, ui-files and resource files.
diff --git a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp
index c1bd9ceeb36f33bdf2905c27aa4db9b0ecae0f13..3813c2d3e735bb2ac488fa41c0e10befe7bf71cc 100644
--- a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp
+++ b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp
@@ -33,8 +33,8 @@
\class Core::IExternalEditor
\mainclass
- \brief Core::IExternalEditor allows for registering an external
- Editor in the \gui{Open With...} dialogs .
+ \brief The IExternalEditor class enables registering an external
+ editor in the \gui{Open with} dialog.
*/
/*!
diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp
index f0b1bde4f5aa74554c8349eb12a2946068ff8b2a..d2dd7ffb3912b1b56f67237ee65ef37c370f30e9 100644
--- a/src/plugins/coreplugin/featureprovider.cpp
+++ b/src/plugins/coreplugin/featureprovider.cpp
@@ -33,7 +33,8 @@
\class Core::IFeatureProvider
\mainclass
- \brief The class IFeatureProvider defines an interface to manage features for wizards
+ \brief The IFeatureProvider class defines an interface to manage features
+ for wizards.
The features provided by an object in the object pool implementing IFeatureProvider
will be respected by wizards implementing IWizard.
@@ -68,10 +69,8 @@
/*!
\class Core::Feature
- \brief This class describes a single Feature
-
- This class describes a single Feature to be used
- in Core::FeatureProvider::Features.
+ \brief The Feature class describes a single feature to be used in
+ Core::FeatureProvider::Features.
\sa Core::FeaturesSet
\sa Core::IWizard
@@ -81,12 +80,10 @@
/*!
\class Core::FeatureSet
- \brief This class is a set of features
-
- Features is used to describe available or
- required feature sets and behaves similar to QFlags.
+ \brief The FeatureSet class is a set of available or required feature sets.
- But instead of enums Features relies on string ids
+ This class behaves similarly to QFlags. However, instead of enums, Features
+ relies on string ids
and is therefore extendable.
\sa Core::Feature
diff --git a/src/plugins/coreplugin/generatedfile.cpp b/src/plugins/coreplugin/generatedfile.cpp
index 3f91be3f1c557c7211a2b8acfeedbbbabc688571..c0616efe797da40ca1af8f461f00cb5260a1d385 100644
--- a/src/plugins/coreplugin/generatedfile.cpp
+++ b/src/plugins/coreplugin/generatedfile.cpp
@@ -40,7 +40,7 @@ namespace Core {
/*!
\class Core::GeneratedFile
- \brief Represents a file generated by a wizard.
+ \brief The GeneratedFile class represents a file generated by a wizard.
The Wizard class will check for each file whether it already exists and will
report any errors that may occur during creation of the files.
diff --git a/src/plugins/coreplugin/icore.cpp b/src/plugins/coreplugin/icore.cpp
index 2a616b592ecb22ff17cf64e9d5d1169620dc1f85..a037646c98f960f592e74297df393f2429d76ddd 100644
--- a/src/plugins/coreplugin/icore.cpp
+++ b/src/plugins/coreplugin/icore.cpp
@@ -47,8 +47,8 @@
/*!
\class Core::ICore
- \brief The ICore class allows access to the different part that make up
- the basic functionality of Qt Creator.
+ \brief The ICore class allows access to the different parts that make up
+ the basic functionality of \QC.
You should never create a subclass of this interface. The one and only
instance is created by the Core plugin. You can access this instance
diff --git a/src/plugins/coreplugin/icorelistener.h b/src/plugins/coreplugin/icorelistener.h
index fa918c7a2e979117ebcc3d3648cd73ced2f79695..9d29802dc6f8300649bfd840fd424f9ea1a1a0ba 100644
--- a/src/plugins/coreplugin/icorelistener.h
+++ b/src/plugins/coreplugin/icorelistener.h
@@ -38,8 +38,8 @@ class IEditor;
/*!
\class Core::ICoreListener
- \brief Provides a hook for plugins to veto on certain events emitted from
-the core plugin.
+ \brief The ICoreListener class provides a hook for plugins to veto on certain
+ events emitted from the core plugin.
You implement this interface if you want to prevent certain events from
occurring, e.g. if you want to prevent the closing of the whole application
diff --git a/src/plugins/coreplugin/id.cpp b/src/plugins/coreplugin/id.cpp
index 20a5e218374f480ddc8dc167950c2191f6ae5a18..8454b427f15ad2a3719b1fbef05852a53a1b0ba5 100644
--- a/src/plugins/coreplugin/id.cpp
+++ b/src/plugins/coreplugin/id.cpp
@@ -43,8 +43,8 @@ namespace Core {
/*!
\class Core::Id
- \brief The class Id encapsulates an identifier that is unique
- within a specific running Qt Creator process.
+ \brief The Id class encapsulates an identifier that is unique
+ within a specific running \QC process.
\c{Core::Id} is used as facility to identify objects of interest
in a more typesafe and faster manner than a plain \c QString or
diff --git a/src/plugins/coreplugin/mimedatabase.cpp b/src/plugins/coreplugin/mimedatabase.cpp
index f8c66a5b249ce31aba36f702ded41386b338f1ac..3d84dbd113c79a9997f11bb52fc6c5cf1e5347d4 100644
--- a/src/plugins/coreplugin/mimedatabase.cpp
+++ b/src/plugins/coreplugin/mimedatabase.cpp
@@ -93,7 +93,8 @@ enum {
/*!
\class Core::IMagicMatcher
- \brief Interface for a Mime type magic matcher (examinig file contents).
+ \brief The IMagicMatcher class is an interface for a MIME type magic
+ matcher that examines file contents to determine the MIME type of a file.
\sa Core::MimeType, Core::MimeDatabase, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern
\sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher
@@ -109,7 +110,8 @@ namespace Internal {
/*!
\class Core::Internal::FileMatchContext
- \brief Context passed on to the mime types when looking for a file match.
+ \brief The FileMatchContext class is the context passed on to the MIME
+ types when looking for a file match.
It exists to enable reading the file contents "on demand"
(as opposed to each mime type trying to open and read while checking).
@@ -173,7 +175,8 @@ QByteArray FileMatchContext::data()
/*!
\class Core::Internal::BinaryMatcher
- \brief The binary fallback matcher for mime type "application/octet-stream".
+ \brief The BinaryMatcher class is the binary fallback matcher for the MIME
+ type \c{application/octet-stream}.
\sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule, Core::GlobPattern
\sa Core::Internal::FileMatchContext, Core::Internal::HeuristicTextMagicMatcher
@@ -190,7 +193,8 @@ public:
/*!
\class Core::Internal::HeuristicTextMagicMatcher
- \brief Heuristic text file matcher for mime types.
+ \brief The HeuristicTextMagicMatcher class implements a heuristic text file
+ matcher for MIME types.
If the data do not contain any character below tab (9), detect as text.
Additionally, check on UTF16 byte order markers.
@@ -235,7 +239,8 @@ bool HeuristicTextMagicMatcher::matches(const QByteArray &data) const
/*!
\class Core::MagicRule
- \brief Base class for standard Magic match rules based on contents
+ \brief The MagicRule class is a base class for standard Magic matching rules
+ based on contents
and offset specification.
Stores the offset and provides conversion helpers.
@@ -281,7 +286,7 @@ QPair<int, int> MagicRule::fromOffset(const QString &offset)
/*!
\class Core::MagicStringRule
- \brief Match on a string.
+ \brief The MagicStringRule class provides rules for matching strings.
\sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicByteRule, Core::GlobPattern
\sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher
@@ -327,7 +332,8 @@ bool MagicStringRule::matches(const QByteArray &data) const
/*!
\class Core::MagicByteRule
- \brief Match on a sequence of binary data.
+ \brief The MagicByteRule class provides rules for matching a sequence of
+ binary data.
Format:
\code
@@ -410,7 +416,8 @@ bool MagicByteRule::matches(const QByteArray &data) const
/*!
\class Core::MagicRuleMatcher
- \brief A Magic matcher that checks a number of rules based on operator "or".
+ \brief The MagicRuleMatcher class implements a Magic matcher that checks the
+ number of rules based on the boolean operator OR.
It is used for rules parsed from XML files.
@@ -474,7 +481,8 @@ IMagicMatcher::IMagicMatcherList MagicRuleMatcher::createMatchers(
/*!
\class Core::GlobPattern
- \brief Glob pattern for file names for mime type matching.
+ \brief The GlobPattern class provides a glob pattern for file names for
+ MIME type matching.
\sa Core::MimeType, Core::MimeDatabase, Core::IMagicMatcher, Core::MagicRuleMatcher, Core::MagicRule, Core::MagicStringRule, Core::MagicByteRule
\sa Core::Internal::FileMatchContext, Core::Internal::BinaryMatcher, Core::Internal::HeuristicTextMagicMatcher
@@ -518,7 +526,7 @@ bool MimeGlobPattern::matches(const QString &fileName) const
/*!
\class Core::MimeType
- \brief Mime type data used in Qt Creator.
+ \brief The MimeType class contains MIME type data used in \QC.
Contains most information from standard mime type XML database files.
@@ -918,7 +926,8 @@ namespace Internal {
/*!
\class Core::Internal::BaseMimeTypeParser
- \brief Generic parser for a sequence of <mime-type>.
+ \brief The BaseMimeTypeParser class provides a generic parser for a
+ sequence of <mime-type>.
Calls abstract handler function process for MimeType it finds.
@@ -1183,7 +1192,8 @@ MimeMapEntry::MimeMapEntry(const MimeType &t, int aLevel) :
/*!
\class Core::MimeDatabase
- \brief Mime data base to which the plugins can add the mime types they handle.
+ \brief The MimeDatabase class is a MIME type database to which the plugins
+ can add the MIME types they handle.
The class is protected by a QMutex and can therefore be accessed by threads.
@@ -1302,7 +1312,7 @@ MimeDatabasePrivate::MimeDatabasePrivate() :
/*!
\class Core::Internal::MimeTypeParser
- \brief Mime type parser
+ \brief The MimeTypeParser class provides a MIME type parser.
Populates Core::MimeDataBase
diff --git a/src/plugins/coreplugin/settingsdatabase.cpp b/src/plugins/coreplugin/settingsdatabase.cpp
index ccfaae9b945e5983835a853bbd0efdc91a2d67d1..c2ca07678301a49cdb83a632f15514c140c9f1c3 100644
--- a/src/plugins/coreplugin/settingsdatabase.cpp
+++ b/src/plugins/coreplugin/settingsdatabase.cpp
@@ -42,7 +42,8 @@
/*!
\class Core::SettingsDatabase
- \brief An alternative to the application-wide QSettings that is more
+ \brief The SettingsDatabase class offers an alternative to the
+ application-wide QSettings that is more
suitable for storing large amounts of data.
The settings database is SQLite based, and lazily retrieves data when it
diff --git a/src/plugins/coreplugin/textdocument.cpp b/src/plugins/coreplugin/textdocument.cpp
index f44a86f2b794e7c122b6013d2c5d8a9264d86917..c083cf2eb2a9abdb0c92ac5ffa3ead76d29dac23 100644
--- a/src/plugins/coreplugin/textdocument.cpp
+++ b/src/plugins/coreplugin/textdocument.cpp
@@ -35,7 +35,8 @@
/*!
\class Core::TextFile
- \brief Base class for text files with encoding helpers.
+ \brief The TextFile class is a base class for text files with encoding
+ helpers.
Stores the format obtained from read operations and uses that when writing
out files, thus ensuring that CRLF/encodings are preserved.
diff --git a/src/plugins/cpaster/cpasterplugin.cpp b/src/plugins/cpaster/cpasterplugin.cpp
index 12102111d1ba0ab31a6957912226c8f5e43c1a0d..5c39007014430ae893bc5c3794fcf11128859ca2 100644
--- a/src/plugins/cpaster/cpasterplugin.cpp
+++ b/src/plugins/cpaster/cpasterplugin.cpp
@@ -69,8 +69,8 @@ namespace CodePaster {
/*!
\class CodePaster::CodePasterService
- \brief Service registered with PluginManager providing CodePaster
- post() functionality.
+ \brief The CodePasterService class is a service registered with PluginManager
+ that provides CodePaster \c post() functionality.
\sa ExtensionSystem::PluginManager::getObjectByClassName, ExtensionSystem::invoke
\sa VcsBase::VcsBaseEditorWidget
diff --git a/src/plugins/cpptools/cppmodelmanager.cpp b/src/plugins/cpptools/cppmodelmanager.cpp
index 71c32abd6f32e3d7c178357fba38eedbe3be01d1..1952cdd70ac2b8b8c968ea03cd29880afb431822 100644
--- a/src/plugins/cpptools/cppmodelmanager.cpp
+++ b/src/plugins/cpptools/cppmodelmanager.cpp
@@ -194,8 +194,8 @@ void CppModelManager::updateModifiedSourceFiles()
/*!
\class CppTools::CppModelManager
- \brief The CppModelManager keeps track of one CppCodeModel instance
- for each project and all related CppCodeModelPart instances.
+ \brief The CppModelManager class keeps track of one CppCodeModel instance
+ for each project and all the related CppCodeModelPart instances.
It also takes care of updating the code models when C++ files are
modified within Qt Creator.
diff --git a/src/plugins/cpptools/cpppointerdeclarationformatter.h b/src/plugins/cpptools/cpppointerdeclarationformatter.h
index e8af400435c17072d4f06908f85b5d533eea664a..0419f8257ef9d4ee856215cea79da09e532b01c6 100644
--- a/src/plugins/cpptools/cpppointerdeclarationformatter.h
+++ b/src/plugins/cpptools/cpppointerdeclarationformatter.h
@@ -46,7 +46,8 @@ typedef Utils::ChangeSet::Range Range;
/*!
\class CppTools::PointerDeclarationFormatter
- \brief Rewrite pointer or reference declarations accordingly to an Overview.
+ \brief The PointerDeclarationFormatter class rewrites pointer or reference
+ declarations to an Overview.
The following constructs are supported:
\list
diff --git a/src/plugins/debugger/debuggerplugin.cpp b/src/plugins/debugger/debuggerplugin.cpp
index 5b5793b426c1869d1c34e273d8b60c6bd57820f3..334e7b334d28580af2a216040fdab25a77839eae 100644
--- a/src/plugins/debugger/debuggerplugin.cpp
+++ b/src/plugins/debugger/debuggerplugin.cpp
@@ -154,7 +154,7 @@
/*!
\class Debugger::DebuggerEngine
- \brief Base class of a debugger engine.
+ \brief The DebuggerEngine class is the base class of a debugger engine.
Note: the Debugger process itself and any helper processes like
gdbserver are referred to as 'Engine', whereas the debugged process
@@ -322,7 +322,8 @@ sg1: }
/*!
\class Debugger::Internal::GdbEngine
- \brief Implementation of Debugger::Engine driving a gdb executable.
+ \brief The GdbEngine class implements Debugger::Engine driving a GDB
+ executable.
GdbEngine specific startup. All happens in EngineSetupRequested state:
diff --git a/src/plugins/debugger/debuggersourcepathmappingwidget.cpp b/src/plugins/debugger/debuggersourcepathmappingwidget.cpp
index 93cbed5375ea8b7770a6cebe2e43eeb0ab15ff46..5896140b3698f16b2d84a8ead012839ef833b860 100644
--- a/src/plugins/debugger/debuggersourcepathmappingwidget.cpp
+++ b/src/plugins/debugger/debuggersourcepathmappingwidget.cpp
@@ -68,7 +68,8 @@ typedef DebuggerSourcePathMappingWidget::SourcePathMap SourcePathMap;
/*!
\class Debugger::Internal::SourcePathMappingModel
- \brief Model for DebuggerSourcePathMappingWidget.
+ \brief The SourcePathMappingModel class is a model for the
+ DebuggerSourcePathMappingWidget class.
Maintains mappings and a dummy placeholder row for adding new mappings.
*/
@@ -189,7 +190,8 @@ void SourcePathMappingModel::setTarget(int row, const QString &t)
/*!
\class Debugger::Internal::DebuggerSourcePathMappingWidget
- \brief Widget for maintaining a set of source path mappings for the debugger.
+ \brief The DebuggerSourcePathMappingWidget class is a widget for maintaining
+ a set of source path mappings for the debugger.
Path mappings to be applied using source path substitution in gdb.
*/
diff --git a/src/plugins/debugger/debuggertooltipmanager.cpp b/src/plugins/debugger/debuggertooltipmanager.cpp
index 5237962ef43a884519155aaec7d6fdc4266ee16d..75e0a2b7caeb16ffb546282039d4b866695a7426 100644
--- a/src/plugins/debugger/debuggertooltipmanager.cpp
+++ b/src/plugins/debugger/debuggertooltipmanager.cpp
@@ -518,8 +518,11 @@ void DebuggerToolTipWidget::toolButtonClicked()
/*!
\class Debugger::Internal::DebuggerToolTipContext
- File name and position where the tooltip is anchored. Redundant position/line column
- information is used to detect if the underlying file has been changed
+ \brief The DebuggerToolTipContext class specifies the file name and
+ position where the tooltip is anchored.
+
+ Uses redundant position or line column information to detect whether
+ the underlying file has been changed
on restoring.
*/
@@ -552,7 +555,10 @@ QDebug operator<<(QDebug d, const DebuggerToolTipContext &c)
/*!
\class Debugger::Internal::DebuggerToolTipWidget
- A debugger tooltip is pinnable. It goes from the unpinned state (button
+ \brief The DebuggerToolTipWidget class is a pinnable debugger tool tip
+ widget.
+
+ The debugger tooltip goes from the unpinned state (button
showing 'Pin') to the pinned state (button showing 'Close').
It consists of a title toolbar and a vertical main layout.
The widget has the ability to save/restore tree model contents to XML.
@@ -814,7 +820,8 @@ void DebuggerToolTipWidget::saveSessionData(QXmlStreamWriter &w) const
/*!
\class Debugger::Internal::TooltipFilterModel
- \brief Model for tooltips filtering an item on the watchhandler matching its tree on the iname.
+ \brief The TooltipFilterModel class is a model for tooltips filtering an
+ item on the watchhandler matching its tree on the iname.
In addition, suppress the model's tooltip data to avoid a tooltip on a tooltip.
*/
@@ -857,7 +864,8 @@ bool TooltipFilterModel::filterAcceptsRow(int sourceRow, const QModelIndex &sour
/*!
\class Debugger::Internal::DebuggerToolTipTreeView
- A treeview that adapts its size to the model contents (also while expanding)
+ \brief The DebuggerToolTipTreeView class is a treeview that adapts its size
+ to the model contents (also while expanding)
to be used within DebuggerTreeViewToolTipWidget.
*/
@@ -1074,7 +1082,8 @@ QString DebuggerToolTipWidget::clipboardContents() const
/*!
\class Debugger::Internal::DebuggerToolTipManager
- Manages the pinned tooltip widgets, listens on editor scroll and main window move
+ \brief The DebuggerToolTipManager class manages the pinned tooltip widgets,
+ listens on editor scroll and main window move
events and takes care of repositioning the tooltips.
Listens to editor change and mode change. In debug mode, if there tooltips
diff --git a/src/plugins/debugger/memoryview.cpp b/src/plugins/debugger/memoryview.cpp
index a03b3a8976e7d9731b439f68594d4e769d6bfa9f..38d10d44d424e965fc86bd464dddfa1ef15ccd0e 100644
--- a/src/plugins/debugger/memoryview.cpp
+++ b/src/plugins/debugger/memoryview.cpp
@@ -41,7 +41,7 @@ namespace Internal {
/*!
\class Debugger::Internal::MemoryView
- \brief Base class for memory view tool windows
+ \brief The MemoryView class is a base class for memory view tool windows.
Small tool-window that stays on top and displays a chunk of memory
based on the widget provided by the Bin editor plugin.
@@ -121,7 +121,8 @@ void MemoryView::setMarkup(const QList<MemoryMarkup> &m)
/*!
\class Debugger::Internal::RegisterMemoryView
- \brief Memory view that shows the memory around the contents of a register
+ \brief The RegisterMemoryView class provides a memory view that shows the
+ memory around the contents of a register
(such as stack pointer, program counter),
tracking changes of the register value.
diff --git a/src/plugins/debugger/snapshothandler.cpp b/src/plugins/debugger/snapshothandler.cpp
index ea088f7eaa85299a6dd8869723620f2a2ba5e03b..4817de345e900d5daa9ce9e82f45a2a8db8c7821 100644
--- a/src/plugins/debugger/snapshothandler.cpp
+++ b/src/plugins/debugger/snapshothandler.cpp
@@ -113,7 +113,8 @@ QDebug operator<<(QDebug d, const SnapshotData &f)
/*!
\class Debugger::Internal::SnapshotHandler
- \brief A model to represent the snapshots in a QTreeView.
+ \brief The SnapshotHandler class provides a model to represent the
+ snapshots in a QTreeView.
A snapshot represents a debugging session.
*/
diff --git a/src/plugins/debugger/stackhandler.cpp b/src/plugins/debugger/stackhandler.cpp
index 18a61f6395252b5abaee0c187d9f38fd8d916574..138a6663c9e9b4ef67b3dfb32d328eaa4d201a3e 100644
--- a/src/plugins/debugger/stackhandler.cpp
+++ b/src/plugins/debugger/stackhandler.cpp
@@ -49,7 +49,8 @@ namespace Internal {
/*!
\class Debugger::Internal::StackHandler
- \brief A model to represent the stack in a QTreeView.
+ \brief The StackHandler class provides a model to represent the stack in a
+ QTreeView.
*/
StackHandler::StackHandler()
diff --git a/src/plugins/debugger/threadshandler.cpp b/src/plugins/debugger/threadshandler.cpp
index 19f093f95e1f2c43445cc6d82ca5437127e663bf..4f7522e71f8be45d929234d5946b60f65b0f35ec 100644
--- a/src/plugins/debugger/threadshandler.cpp
+++ b/src/plugins/debugger/threadshandler.cpp
@@ -116,13 +116,17 @@ static QString threadToolTip(const ThreadData &thread)
///////////////////////////////////////////////////////////////////////
/*!
- \struct Debugger::Internal::ThreadData
- \brief A structure containing information about a single thread
+ \class Debugger::Internal::ThreadData
+ \internal
+ \brief The ThreadData class contains information
+ about a single thread.
*/
/*!
\class Debugger::Internal::ThreadsHandler
- \brief A model to represent the running threads in a QTreeView or ComboBox
+ \internal
+ \brief The ThreadsHandler class provides a model to
+ represent the running threads in a QTreeView or ComboBox.
*/
ThreadsHandler::ThreadsHandler()
diff --git a/src/plugins/find/searchresultwindow.cpp b/src/plugins/find/searchresultwindow.cpp
index cda06a6464e5a61513470b3d8ba9a44aaee5f118..12b1181e6ac7ff51df74d086d94dedd62b975b0f 100644
--- a/src/plugins/find/searchresultwindow.cpp
+++ b/src/plugins/find/searchresultwindow.cpp
@@ -201,7 +201,8 @@ using namespace Find::Internal;
/*!
\class Find::SearchResult
- \brief Reports user interaction like activation of a search result item.
+ \brief The SearchResult class reports user interaction, such as the
+ activation of a search result item.
Whenever a new search is initiated via startNewSearch, an instance of this
class is returned to provide the initiator with the hooks for handling user
diff --git a/src/plugins/git/branchadddialog.cpp b/src/plugins/git/branchadddialog.cpp
index 61b8fb2f18426bb79871370d9f3c4333f6b5a37c..979b0cdb545ef81b827c655a6fbbe31263faa05a 100644
--- a/src/plugins/git/branchadddialog.cpp
+++ b/src/plugins/git/branchadddialog.cpp
@@ -37,7 +37,8 @@ namespace Git {
namespace Internal {
/*!
- * \brief Validates the corresponding string as a valid git branch name
+ * \brief The BranchNameValidator class validates the corresponding string as
+ * a valid Git branch name.
*
* The class does this by a couple of rules that are applied on the string.
*
diff --git a/src/plugins/macros/imacrohandler.cpp b/src/plugins/macros/imacrohandler.cpp
index 51b7c026423c7e50c0852e8e19ec88fd7d494909..e0d1a4cfe33eaa5007c131644f419f46081bd936 100644
--- a/src/plugins/macros/imacrohandler.cpp
+++ b/src/plugins/macros/imacrohandler.cpp
@@ -35,7 +35,7 @@ using namespace Macros;
/*!
\class Macro::IEventHandler
- \brief Base class for all macro event handlers.
+ \brief The IEventHandler class is a base class for all macro event handlers.
An event handler is used to handle a specific type of macro events.
They are used to create and replay macro events, use MacroManager::registerEventHandler
diff --git a/src/plugins/macros/macro.cpp b/src/plugins/macros/macro.cpp
index 91a8008afcd7cd47804b8c61b2a091fc1d19d6cb..a345f06e208d5b4b8dd27602f317bda531d24c3a 100644
--- a/src/plugins/macros/macro.cpp
+++ b/src/plugins/macros/macro.cpp
@@ -41,7 +41,8 @@ using namespace Macros;
/*!
\class Macros::Macro
- \brief Represents a macro, which is more or less a list of Macros::MacroEvent
+ \brief The Macro class represents a macro, which is more or less a list of
+ Macros::MacroEvent.
A macro is a list of events that can be replayed in Qt Creator. A macro has
an header consisting of the Qt Creator version where the macro was created
diff --git a/src/plugins/macros/macroevent.cpp b/src/plugins/macros/macroevent.cpp
index 1accf695312341fe1f1b90350202eefe8358f072..9c7aae96da24831b168d55cf9d5935a5e5e4a7e2 100644
--- a/src/plugins/macros/macroevent.cpp
+++ b/src/plugins/macros/macroevent.cpp
@@ -37,14 +37,13 @@ using namespace Macros;
/*!
\class Macros::MacroEvent
- \brief Represents an event in a macro
+ \brief The MacroEvent class represents an event in a macro.
An event stores information so it can be replayed. An event can be:
\list
\li menu action
\li key event on an editor
\li find/replace usage
- \li ...
\endlist
The information are stored in a map of QVariants (using quint8 for keys).
diff --git a/src/plugins/macros/macromanager.cpp b/src/plugins/macros/macromanager.cpp
index 99ff767af049870ab7860c03248b52b08773aaa9..002a12427d897556bfa9d4f10d165109f41ee658 100644
--- a/src/plugins/macros/macromanager.cpp
+++ b/src/plugins/macros/macromanager.cpp
@@ -67,13 +67,13 @@ using namespace Macros::Internal;
/*!
\namespace Macros
- \brief The Macros namespace contains support for macros in Qt Creator.
+ \brief The Macros namespace contains support for macros in \QC.
*/
/*!
\class Macro::MacroManager
- \brief Manager for macros.
+ \brief The MacroManager class implements a manager for macros.
The MacroManager manage all macros, it loads them on startup, keep track of the
current macro and create new macros.
diff --git a/src/plugins/projectexplorer/abi.cpp b/src/plugins/projectexplorer/abi.cpp
index c9551fbd2fddf185cf28e66b798cb8b05530ed2e..f4f484bc72513da451dd6a176fe094db07150371 100644
--- a/src/plugins/projectexplorer/abi.cpp
+++ b/src/plugins/projectexplorer/abi.cpp
@@ -41,7 +41,8 @@
/*!
\class ProjectExplorer::Abi
- \brief Represents the Application Binary Interface (ABI) of a target platform.
+ \brief The Abi class represents the Application Binary Interface (ABI) of
+ a target platform.
\sa ProjectExplorer::ToolChain
*/
diff --git a/src/plugins/projectexplorer/abiwidget.cpp b/src/plugins/projectexplorer/abiwidget.cpp
index 4d5c588bc9b1e115ac6a2052b1876df03cd8db84..05d15a211b59a016f7f361aa45a836cd2d3c2518 100644
--- a/src/plugins/projectexplorer/abiwidget.cpp
+++ b/src/plugins/projectexplorer/abiwidget.cpp
@@ -37,7 +37,7 @@
/*!
\class ProjectExplorer::AbiWidget
- \brief A widget to set an ABI.
+ \brief The AbiWidget class is a widget to set an ABI.
\sa ProjectExplorer::Abi
*/
diff --git a/src/plugins/projectexplorer/abstractprocessstep.cpp b/src/plugins/projectexplorer/abstractprocessstep.cpp
index 2c31d5c61e5b84b61f962b94e26af3578fdd361c..5b0bc84c34bad8bda5a906067e370cc36f329b10 100644
--- a/src/plugins/projectexplorer/abstractprocessstep.cpp
+++ b/src/plugins/projectexplorer/abstractprocessstep.cpp
@@ -45,7 +45,8 @@ using namespace ProjectExplorer;
/*!
\class ProjectExplorer::AbstractProcessStep
- \brief A convenience class, which can be used as a base class instead of BuildStep.
+ \brief The AbstractProcessStep class is a convenience class that can be
+ used as a base class instead of BuildStep.
It should be used as a base class if your buildstep just needs to run a process.
diff --git a/src/plugins/projectexplorer/applicationlauncher.cpp b/src/plugins/projectexplorer/applicationlauncher.cpp
index 51d87a5fceb937e38beb947917fef565a8d48731..3404b6c2268c4af1461f88694facf25234723c7a 100644
--- a/src/plugins/projectexplorer/applicationlauncher.cpp
+++ b/src/plugins/projectexplorer/applicationlauncher.cpp
@@ -52,7 +52,8 @@
/*!
\class ProjectExplorer::ApplicationLauncher
- \brief Application launcher of the ProjectExplorer plugin.
+ \brief The ApplicationLauncher class is the application launcher of the
+ ProjectExplorer plugin.
Encapsulates processes running in a console or as GUI processes,
captures debug output of GUI processes on Windows (outputDebugString()).
diff --git a/src/plugins/projectexplorer/baseprojectwizarddialog.cpp b/src/plugins/projectexplorer/baseprojectwizarddialog.cpp
index cfaf30c94f8630a5199f493f04b76b662e14b47c..bb4ba350c9043d465edb23f2f87b6870e95f44d5 100644
--- a/src/plugins/projectexplorer/baseprojectwizarddialog.cpp
+++ b/src/plugins/projectexplorer/baseprojectwizarddialog.cpp
@@ -37,7 +37,8 @@
/*!
\class ProjectExplorer::BaseProjectWizardDialog
- \brief Base class for project wizards.
+ \brief The BaseProjectWizardDialog class is the base class for project
+ wizards.
Presents the introductory page and takes care of setting the folder chosen
as default projects' folder should the user wish to do that.
diff --git a/src/plugins/projectexplorer/buildconfigurationmodel.cpp b/src/plugins/projectexplorer/buildconfigurationmodel.cpp
index 4d44118d24386f6614111522e51fd7a1a4573591..8c6a955d614cb0488fb27441f6601cb9351e016d 100644
--- a/src/plugins/projectexplorer/buildconfigurationmodel.cpp
+++ b/src/plugins/projectexplorer/buildconfigurationmodel.cpp
@@ -35,11 +35,13 @@ using namespace ProjectExplorer;
/*!
\class ProjectExplorer::BuildConfigurationModel
- \brief A model to represent the build configurations of a target.
+ \brief The BuildConfigurationModel class is a model to represent the build
+ configurations of a target.
To be used in for the drop down of comboboxes.
Does automatically adjust itself to added and removed BuildConfigurations
Very similar to the Run Configuration Model.
+
TODO might it possible to share code without making the code a complete mess.
*/
diff --git a/src/plugins/projectexplorer/buildstep.cpp b/src/plugins/projectexplorer/buildstep.cpp
index 2d42b85429c3a80596d314c6f31dac9bb681936e..c39fecac41da6cb9384ae0caa017060354545086 100644
--- a/src/plugins/projectexplorer/buildstep.cpp
+++ b/src/plugins/projectexplorer/buildstep.cpp
@@ -37,22 +37,24 @@
/*!
\class ProjectExplorer::BuildStep
- \brief BuildSteps are the primary way plugin developers can customize
- how their projects (or projects from other plugins) are build.
+ \brief The BuildStep class provides build steps for projects.
- Building a project, is done by taking the list of buildsteps
- from the project and calling first init() than run() on them.
+ Build steps are the primary way plugin developers can customize
+ how their projects (or projects from other plugins) are built.
- That means to change the way your project is build, reimplemnt
- this class and add your Step to the buildStep list of the project.
+ Projects are built by taking the list of build steps
+ from the project and calling first \c init() and then \c run() on them.
- Note: The projects own the buildstep, do not delete them yourself.
+ To change the way your project is built, reimplement
+ this class and add your build step to the build step list of the project.
- init() is called in the GUI thread and can be used to query the
+ \note The projects own the build step. Do not delete them yourself.
+
+ \c init() is called in the GUI thread and can be used to query the
project for any information you need.
- run() is run via QtConccurrent in a own thread, if you need an
- eventloop you need to create it yourself!
+ \c run() is run via QtConcurrent in a separate thread. If you need an
+ event loop, you need to create it yourself.
*/
/*!
diff --git a/src/plugins/projectexplorer/customwizard/customwizard.cpp b/src/plugins/projectexplorer/customwizard/customwizard.cpp
index 58d6cf6c2a79870d851d838d035090adfaacb8cb..cd3c717ffcb73af4ca60b2c7103af1ce0bf50d4e 100644
--- a/src/plugins/projectexplorer/customwizard/customwizard.cpp
+++ b/src/plugins/projectexplorer/customwizard/customwizard.cpp
@@ -54,8 +54,9 @@ namespace ProjectExplorer {
/*!
\class ProjectExplorer::ICustomWizardFactory
- \brief Factory for creating custom wizards extending the base class
- (CustomWizard or CustomProjectWizard)
+ \brief The ICustomWizardFactory class implements a factory for creating
+ custom wizards extending the base classes: CustomWizard and
+ CustomProjectWizard.
The factory can be registered under a name in CustomWizard. The name can
be specified in the \c <wizard class=''...> attribute in the \c wizard.xml file
@@ -79,7 +80,8 @@ int CustomWizardPrivate::verbose = 0;
/*!
\class ProjectExplorer::CustomWizard
- \brief Base classes for custom wizards based on file templates and a XML
+ \brief The CustomWizard class is a base class for custom wizards based on
+ file templates and an XML
configuration file (\c share/qtcreator/templates/wizards).
Presents CustomWizardDialog (fields page containing path control) for wizards
diff --git a/src/plugins/projectexplorer/customwizard/customwizardpage.cpp b/src/plugins/projectexplorer/customwizard/customwizardpage.cpp
index 72ce236fba5b7f6b46c4b307ed909559eb8f52af..5e847e63b0b6294e057aa3e6375a0b8c1a9834b6 100644
--- a/src/plugins/projectexplorer/customwizard/customwizardpage.cpp
+++ b/src/plugins/projectexplorer/customwizard/customwizardpage.cpp
@@ -58,8 +58,9 @@ namespace Internal {
/*!
\class ProjectExplorer::Internal::TextFieldComboBox
- \brief A non-editable combo for text editing purposes that plays
- with QWizard::registerField (providing a settable 'text' property).
+ \brief The TextFieldComboBox class is a non-editable combo box for text
+ editing purposes that plays with \c QWizard::registerField (providing a
+ settable 'text' property).
Allows for a separation of values to be used for wizard fields replacement
and display texts.
@@ -110,7 +111,8 @@ QString TextFieldComboBox::valueAt(int i) const
/*!
\class ProjectExplorer::Internal::TextFieldCheckBox
- \brief A Checkbox that plays with QWizard::registerField.
+ \brief The TextFieldCheckBox class is a aheckbox that plays with
+ \c QWizard::registerField.
Provides a settable 'text' property containing predefined strings for 'true'/'false').
@@ -141,7 +143,8 @@ void TextFieldCheckBox::slotStateChanged(int cs)
/*!
\class ProjectExplorer::Internal::CustomWizardFieldPage
- \brief A simple custom wizard page presenting the fields to be used
+ \brief The CustomWizardFieldPage class is a simple custom wizard page
+ presenting the fields to be used
as page 2 of a BaseProjectWizardDialog if there are any fields.
Uses the 'field' functionality of QWizard.
diff --git a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp
index 98badd342cf5193cc351197aba7b5690bd42cd1e..c8b8de00644831bb5a036591045a5394ed146013 100644
--- a/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp
+++ b/src/plugins/projectexplorer/customwizard/customwizardparameters.cpp
@@ -156,7 +156,8 @@ CustomWizardFile::CustomWizardFile() :
/*!
\class ProjectExplorer::CustomWizardValidationRule
- \brief A custom wizard validation rule based on JavaScript-expressions over
+ \brief The CustomWizardValidationRule class provides a custom wizard
+ validation rule based on JavaScript-expressions over
the field placeholders.
Placeholder replacement is performed on the condition and it is evaluated
@@ -561,7 +562,8 @@ static inline QString languageSetting()
/*!
\class ProjectExplorer::Internal::GeneratorScriptArgument
- \brief Argument to a custom wizard generator script.
+ \brief The GeneratorScriptArgument class provides an argument to a custom
+ wizard generator script.
Contains placeholders to be replaced by field values or file names
as in \c '--class-name=%ClassName%' or \c '--description=%Description%'.
diff --git a/src/plugins/projectexplorer/deployconfigurationmodel.cpp b/src/plugins/projectexplorer/deployconfigurationmodel.cpp
index 3e948d3790d1e53ff29ce240a6ab4c2348c9dcd6..c2c66d4436af54788101172bcc79cae2bd98b0e1 100644
--- a/src/plugins/projectexplorer/deployconfigurationmodel.cpp
+++ b/src/plugins/projectexplorer/deployconfigurationmodel.cpp
@@ -36,7 +36,8 @@ using namespace ProjectExplorer;
/*!
\class ProjectExplorer::DeployConfigurationModel
- \brief A model to represent the run configurations of a target.
+ \brief The DeployConfigurationModel class provides a model to represent
+ the run configurations of a target.
To be used in for the drop down of comboboxes. Does automatically adjust
itself to added and removed DeployConfigurations
diff --git a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp
index 75fc23a031aa92d7c36cd822860d9fde4fede0bd..47369df4c26a84d096ac82c543a48b8f0777b3b8 100644
--- a/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp
+++ b/src/plugins/projectexplorer/devicesupport/deviceprocessesdialog.cpp
@@ -296,7 +296,7 @@ DeviceProcess DeviceProcessesDialogPrivate::selectedProcess() const
/*!
\class ProjectExplorer::DeviceProcessesDialog
- \brief Shows a list of processes.
+ \brief The DeviceProcessesDialog class shows a list of processes.
The dialog can be used as a
\list
diff --git a/src/plugins/projectexplorer/devicesupport/idevice.cpp b/src/plugins/projectexplorer/devicesupport/idevice.cpp
index 2d121ae173b2c5dd66bc67c92d4364b0f516d1c9..3f1941e28434bd0918fefff0af1a50fa4b73d11b 100644
--- a/src/plugins/projectexplorer/devicesupport/idevice.cpp
+++ b/src/plugins/projectexplorer/devicesupport/idevice.cpp
@@ -43,7 +43,7 @@
/*!
* \class ProjectExplorer::IDevice
- * \brief This is the base class for all devices.
+ * \brief The IDevice class is the base class for all devices.
*
* The term "device" refers
* here to some host to which e.g. files can be deployed or on which an application can run.
diff --git a/src/plugins/projectexplorer/ioutputparser.cpp b/src/plugins/projectexplorer/ioutputparser.cpp
index fc5882e5f2852af63bea442dee4f352419d82c22..a102b6f60c207ede2aa6d32ea49b5be0a94f6ece 100644
--- a/src/plugins/projectexplorer/ioutputparser.cpp
+++ b/src/plugins/projectexplorer/ioutputparser.cpp
@@ -33,7 +33,8 @@
/*!
\class ProjectExplorer::IOutputParser
- \brief Interface for an output parser that emit issues (tasks).
+ \brief The IOutputParser class provides an interface for an output parser
+ that emits issues (tasks).
\sa ProjectExplorer::Task
*/
diff --git a/src/plugins/projectexplorer/pluginfilefactory.cpp b/src/plugins/projectexplorer/pluginfilefactory.cpp
index 86e24a46b2ad26f79b877c89cbb0e52a0e09b940..64353d644c4f37ff60a76a846de0442225b3224f 100644
--- a/src/plugins/projectexplorer/pluginfilefactory.cpp
+++ b/src/plugins/projectexplorer/pluginfilefactory.cpp
@@ -45,7 +45,7 @@ using namespace ProjectExplorer::Internal;
/*!
\class ProjectExplorer::Internal::ProjectFileFactory
- \brief Factory for project files.
+ \brief The ProjectFileFactory class provides a factory for project files.
*/
ProjectFileFactory::ProjectFileFactory(IProjectManager *manager)
diff --git a/src/plugins/projectexplorer/processparameters.cpp b/src/plugins/projectexplorer/processparameters.cpp
index da86fff931ed595480a4f7c5da8e0addcbdf9638..649225361d7e9d531862ea4758ac153abf0a9f80 100644
--- a/src/plugins/projectexplorer/processparameters.cpp
+++ b/src/plugins/projectexplorer/processparameters.cpp
@@ -38,7 +38,8 @@
/*!
\class ProjectExplorer::ProcessParameters
- \brief ProcessParameters aggregates all parameters needed to start a process.
+ \brief The ProcessParameters class aggregates all parameters needed to start
+ a process.
It offers a set of functions which expand macros and environment variables
inside the raw parameters to obtain final values for starting a process
diff --git a/src/plugins/projectexplorer/project.cpp b/src/plugins/projectexplorer/project.cpp
index 9f634eec07c4df33fa270cda3ff752b546503072..a66fdc32c1290956910073db4d731d9c4fee9a1e 100644
--- a/src/plugins/projectexplorer/project.cpp
+++ b/src/plugins/projectexplorer/project.cpp
@@ -45,7 +45,7 @@
/*!
\class ProjectExplorer::Project
- \brief A project.
+ \brief The Project class implements a project node in the project explorer.
*/
/*!
diff --git a/src/plugins/projectexplorer/projectexplorer.cpp b/src/plugins/projectexplorer/projectexplorer.cpp
index e83723b7daa9526fdfa31780ba95415e9a2f0497..73359ffc6ed5a7bc540b26afdf5b79fe26406df3 100644
--- a/src/plugins/projectexplorer/projectexplorer.cpp
+++ b/src/plugins/projectexplorer/projectexplorer.cpp
@@ -139,8 +139,8 @@
/*!
\class ProjectExplorer::ProjectExplorerPlugin
- \brief ProjectExplorerPlugin with static accessor and utility functions to obtain
- current project, open projects, etc.
+ \brief The ProjectExplorerPlugin class contains static accessor and utility
+ functions to obtain the current project, open projects, and so on.
*/
namespace {
diff --git a/src/plugins/projectexplorer/projectfilewizardextension.cpp b/src/plugins/projectexplorer/projectfilewizardextension.cpp
index b1ffbec7ac2d0f50758f4d62d673d7de03f0f88f..dca5a2c688b9a9bcf1d327c8b32d58d38d8315eb 100644
--- a/src/plugins/projectexplorer/projectfilewizardextension.cpp
+++ b/src/plugins/projectexplorer/projectfilewizardextension.cpp
@@ -64,7 +64,8 @@
/*!
\class ProjectExplorer::Internal::ProjectFileWizardExtension
- \brief Post-file generating steps of a project wizard.
+ \brief The ProjectFileWizardExtension class implements the post-file
+ generating steps of a project wizard.
Offers:
\list
diff --git a/src/plugins/projectexplorer/projectnodes.cpp b/src/plugins/projectexplorer/projectnodes.cpp
index 021bbbd211b5b21d1747ecf166e6c4b2b914b870..3b81a0b498fbc4654aa763e0509886602f3b013b 100644
--- a/src/plugins/projectexplorer/projectnodes.cpp
+++ b/src/plugins/projectexplorer/projectnodes.cpp
@@ -49,7 +49,7 @@ using namespace ProjectExplorer;
/*!
\class ProjectExplorer::Node
- \brief Base class of all nodes in the node hierarchy.
+ \brief The Node class is the base class of all nodes in the node hierarchy.
The nodes are arranged in a tree where leaves are FileNodes and non-leaves are FolderNodes
A Project is a special Folder that manages the files and normal folders underneath it.
diff --git a/src/plugins/projectexplorer/projectwizardpage.cpp b/src/plugins/projectexplorer/projectwizardpage.cpp
index d6d4df063113c5ae04b60f2deed64da5073e50bc..c8077db03ba24b6c47704adb763037585907b5fe 100644
--- a/src/plugins/projectexplorer/projectwizardpage.cpp
+++ b/src/plugins/projectexplorer/projectwizardpage.cpp
@@ -40,7 +40,8 @@
/*!
\class ProjectExplorer::Internal::ProjectWizardPage
- \brief Wizard page showing projects and version control to add new files to.
+ \brief The ProjectWizardPage class provides a wizard page showing projects
+ and version control to add new files to.
\sa ProjectExplorer::Internal::ProjectFileWizardExtension
*/
diff --git a/src/plugins/projectexplorer/runconfiguration.cpp b/src/plugins/projectexplorer/runconfiguration.cpp
index 8f0bf410a9c7bf67172f282adf68166340618ebe..45813b206ae749460fed2f744483d76b1e08b851 100644
--- a/src/plugins/projectexplorer/runconfiguration.cpp
+++ b/src/plugins/projectexplorer/runconfiguration.cpp
@@ -64,7 +64,7 @@ const char USE_MULTIPROCESS_KEY[] = "RunConfiguration.UseMultiProcess";
/*!
\class ProjectExplorer::ProcessHandle
- \brief Helper class to describe a process.
+ \brief The ProcessHandle class is a helper class to describe a process.
Encapsulates parameters of a running process, local (PID) or remote (to be done,
address, port, etc).
@@ -115,15 +115,19 @@ RunConfigWidget *IRunConfigurationAspect::createConfigurationWidget()
/*!
\class ProjectExplorer::RunConfiguration
- \brief Base class for a run configuration. A run configuration specifies how a
- target should be run, while the runner (see below) does the actual running.
+ \brief The RunConfiguration class is the base class for a run configuration.
- Note that all RunControls and the target hold a shared pointer to the RunConfiguration.
- That is the lifetime of the RunConfiguration might exceed the life of the target.
+ A run configuration specifies how a target should be run, while a runner
+ does the actual running.
+
+ All RunControls and the target hold a shared pointer to the run
+ configuration. That is, the lifetime of the run configuration might exceed
+ the life of the target.
The user might still have a RunControl running (or output tab of that RunControl open)
and yet unloaded the target.
- Also, a RunConfiguration might be already removed from the list of RunConfigurations
+ Also, a run configuration might be already removed from the list of run
+ configurations
for a target, but still be runnable via the output tab.
*/
@@ -249,7 +253,8 @@ bool RunConfiguration::fromMap(const QVariantMap &map)
/*!
\class ProjectExplorer::IRunConfigurationAspect
- \brief Extra configuration aspect.
+ \brief The IRunConfigurationAspect class provides an additional
+ configuration aspect.
Aspects are a mechanism to add RunControl-specific options to a RunConfiguration without
subclassing the RunConfiguration for every addition, preventing a combinatorical explosion
@@ -277,7 +282,8 @@ Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const
/*!
\class ProjectExplorer::IRunConfigurationFactory
- \brief Restores RunConfigurations from settings.
+ \brief The IRunConfigurationFactory class restores run configurations from
+ settings.
The run configuration factory is used for restoring run configurations from
settings. And used to create new runconfigurations in the "Run Settings" Dialog.
@@ -368,7 +374,8 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent)
/*!
\class ProjectExplorer::IRunControlFactory
- \brief Creates RunControl objects matching a RunConfiguration
+ \brief The IRunControlFactory class creates RunControl objects matching a
+ run configuration.
*/
/*!
@@ -406,7 +413,7 @@ IRunConfigurationAspect *IRunControlFactory::createRunConfigurationAspect(RunCon
/*!
\class ProjectExplorer::RunControl
- \brief Each instance of this class represents one item that is run.
+ \brief The RunControl class instances represent one item that is run.
*/
/*!
diff --git a/src/plugins/projectexplorer/runconfigurationmodel.cpp b/src/plugins/projectexplorer/runconfigurationmodel.cpp
index 5183206f08febb49a10e8b34ff8f9d6c669103cf..e9d19e7f363c2cf01ce6d98677ff5922c1fb91ea 100644
--- a/src/plugins/projectexplorer/runconfigurationmodel.cpp
+++ b/src/plugins/projectexplorer/runconfigurationmodel.cpp
@@ -36,7 +36,8 @@ using namespace ProjectExplorer;
/*!
\class ProjectExplorer::RunConfigurationModel
- \brief A model to represent the run configurations of a target.
+ \brief The RunConfigurationModel class provides a model to represent the
+ run configurations of a target.
To be used in for the drop down of comboboxes.
Does automatically adjust itself to added and removed RunConfigurations
diff --git a/src/plugins/projectexplorer/session.cpp b/src/plugins/projectexplorer/session.cpp
index cb493df4665d8f8d45baed04073d7fdc06b58c24..8e0dcdea17a92f8fc359f7002801fbab49655f20 100644
--- a/src/plugins/projectexplorer/session.cpp
+++ b/src/plugins/projectexplorer/session.cpp
@@ -67,7 +67,7 @@ using namespace ProjectExplorer::Internal;
/*!
\class ProjectExplorer::SessionManager
- \brief Session management.
+ \brief The SessionManager class manages sessions.
TODO the interface of this class is not really great.
The implementation suffers that all the functions from the
diff --git a/src/plugins/projectexplorer/task.cpp b/src/plugins/projectexplorer/task.cpp
index 42db4a143e2540266120557b322ad063b6651a8a..8fb79e097ab52c3dd04b389d68261482e3e6d072 100644
--- a/src/plugins/projectexplorer/task.cpp
+++ b/src/plugins/projectexplorer/task.cpp
@@ -36,7 +36,7 @@ unsigned int Task::s_nextId = 1;
/*!
\class ProjectExplorer::Task
- \brief Build issue (warning or error).
+ \brief The Task class represents a build issue (warning or error).
\sa ProjectExplorer::TaskHub
*/
diff --git a/src/plugins/projectexplorer/toolchain.cpp b/src/plugins/projectexplorer/toolchain.cpp
index 300812b2ee44325f104a05dd327e37cd10b7ad41..ec532b9df6b4d0554c62dee0ccc232600cc697ff 100644
--- a/src/plugins/projectexplorer/toolchain.cpp
+++ b/src/plugins/projectexplorer/toolchain.cpp
@@ -75,7 +75,7 @@ public:
/*!
\class ProjectExplorer::ToolChain
- \brief Representation of a ToolChain.
+ \brief The ToolChain class represents a tool chain.
\sa ProjectExplorer::ToolChainManager
*/
diff --git a/src/plugins/projectexplorer/windebuginterface.cpp b/src/plugins/projectexplorer/windebuginterface.cpp
index 94f6593c86bcdeae993ebf90d459b9cd29988f05..c8b206b64393f342db0c30e0a45e55e7ea6b0a71 100644
--- a/src/plugins/projectexplorer/windebuginterface.cpp
+++ b/src/plugins/projectexplorer/windebuginterface.cpp
@@ -36,7 +36,8 @@
/*!
\class ProjectExplorer::Internal::WinDebugInterface
- \brief Windows: Captures output of the Windows API OutputDebugString() function.
+ \brief The WinDebugInterface class is used on Windows to capture output of
+ the Windows API \c OutputDebugString() function.
Emits output by process id.
diff --git a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp
index 9951ecd91e7d4a6899bd25bd7cd8be598c8cc53c..867f4b2575106239e88b8748af6340cb8798a80a 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp
@@ -41,8 +41,10 @@
/*!
\class QmlDesigner::Exception
\ingroup CoreExceptions
-\brief This is the abstract base class for all excetions.
- Exceptions should be used in cases there is no other way to say something goes wrong. For example
+\brief The Exception class is the abstract base class for all exceptions.
+
+ Exceptions should be used if there is no other way to indicate that
+ something is going wrong. For example,
the result would be a inconsistent model or a crash.
*/
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp
index 742f485950611b35ca2658b25ca5ea9163656f48..b8c79262ca36d9738c7a4af9f8ffaf013cd1cbe3 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp
@@ -33,7 +33,8 @@
/*!
\class QmlDesigner::InvalidArgumentException
\ingroup CoreExceptions
-\brief Exception for a invalid argument
+\brief The InvalidArgumentException class provides an exception for an invalid
+argument.
*/
namespace QmlDesigner {
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp
index f8e83fae821635e7e724be820f27985478601c01..c5a9f1d517c2a973cc72c6a13c0bc66649feb906 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::InvalidMetaInfoException
\ingroup CoreExceptions
-\brief Exception for a invalid meta info
+\brief The InvalidMetaInfoException class provides an exception for invalid meta
+info.
\see NodeMetaInfo PropertyMetaInfo MetaInfo
*/
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp
index 5ab1ca09a934c2f02351396e49ca7dfe91065850..10d1d2426b90cb6396b44f41be95bcb3d8c2a06e 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::InvalidModelNodeException
\ingroup CoreExceptions
-\brief Exception for a invalid model node
+\brief The InvalidModelNodeException class provides an exception for an invalid
+model node.
\see ModelNode
*/
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp
index 4c5956017f81cf4c647afec365f7b37f17f3dcfa..7c02df82d35fbfa2e756c6884be077543f612a12 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::InvalidModelStateException
\ingroup CoreExceptions
-\brief Exception for a invalid model state
+\brief The InvalidModelStateException class provides an exception for an
+invalid model state.
\see ModelState
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp
index db7bf6f8480af18cf0b6d3186912e10987472cfe..0f6a850dac88287fd6e3ca5fee00373a63f2f5f6 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp
@@ -31,7 +31,8 @@
/*!
\class QmlDesigner::InvalidPropertyException
\ingroup CoreExceptions
-\brief Exception for a invalid property
+\brief The InvalidPropertyException class provides an exception for an invalid
+property.
\see AbstractProperty
*/
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp
index 6fddef98d8d4efe8715db4ace23629c726b670f7..f309573cc80bc000bb938b7d9394923ec44ec4fb 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::InvalidQmlSourceException
\ingroup CoreExceptions
-\brief Exception for invalid qml source code
+\brief The InvalidQmlSourceException class provides an exception for invalid QML
+source code.
*/
namespace QmlDesigner {
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp
index 2dc3613779f58dbd6b212351beea3d490df3c261..8184ff308ffe08b76e0c17613251f901f9dce848 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp
@@ -31,7 +31,8 @@
/*!
\class QmlDesigner::InvalidReparentingException
\ingroup CoreExceptions
-\brief Exception for a invalid reparinting
+ \brief The InvalidReparentingException class provides an exception for
+ invalid reparenting.
\see ModelNode
*/
diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp
index 2de13bd1d998cd85b15c371e083949723e175eff..5989866acac0cef0c6b365bf7cb912d76462f1aa 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::InvalidSlideIndexException
\ingroup CoreExceptions
-\brief Exception for a invalid index for s slide
+\brief The InvalidSlideIndexException class provides an exception for an invalid
+index for a slide.
\see ModelNode
*/
diff --git a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp
index 2a3972f8675517bc4d03bc31a84109d94c1f74da..baa75e07dd6a0572c867a79ee026cdaa0c518eb1 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::ModificationGroupException
\ingroup CoreExceptions
-\brief Exception for a modification group
+\brief The ModificationGroupException class provides an exception for a
+modification group.
*/
namespace QmlDesigner {
diff --git a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp
index d637fdc890339e1a072046be8718a9f5e73cd746..d761903aaae305c43111e5b74d1dc8190a39eb64 100644
--- a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp
+++ b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp
@@ -32,7 +32,8 @@
/*!
\class QmlDesigner::RemoveBaseStateException
\ingroup CoreExceptions
-\brief Exception if you try to remove a BaseState
+ \brief The RemoveBaseStateException class provides an exception if you try
+ to remove a BaseState.
/see NodeState ModelState
*/
diff --git a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp
index 6a920ffffe548dbdfb23993e1621b5acd895e767..cfed9dd14cada9c5767b845f8dc689bf53321b22 100644
--- a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp
+++ b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp
@@ -79,7 +79,8 @@ enum {
/*!
\class QmlDesigner::NodeInstanceView
\ingroup CoreInstance
-\brief Central class to create and manage instances of a ModelNode.
+ \brief The NodeInstanceView class is the central class to create and manage
+ instances of the ModelNode class.
This view is used to instance the ModelNodes. Many AbstractViews hold a
NodeInstanceView to get values from tghe NodeInstances back.
diff --git a/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp b/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp
index aeb51fc4deb966326012d378dc75f4a029435e64..e6d24377585349d8a4f5b1f7f5c2e7720648ee84 100644
--- a/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp
+++ b/src/plugins/qmldesigner/designercore/metainfo/metainfo.cpp
@@ -136,7 +136,8 @@ QStringList MetaInfo::s_pluginDirs;
/*!
\class QmlDesigner::MetaInfo
\ingroup CoreModel
-\brief The MetaInfo class provides meta information about qml types and properties.
+\brief The MetaInfo class provides meta information about QML types and
+properties.
*/
/*!
diff --git a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp
index 9e264747fb2e114d2f0870f5a5803476a7da4a7b..67cc807d8dc8d22d0a566ea81be3186535f2542f 100644
--- a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp
+++ b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp
@@ -47,7 +47,7 @@ namespace QmlDesigner {
/*!
\class QmlDesigner::AbstractProperty
\ingroup CoreModel
-\brief AbstractProperty is a value holder for a property
+\brief The AbstractProperty class is a value holder for a property.
*/
AbstractProperty::AbstractProperty():
diff --git a/src/plugins/qmldesigner/designercore/model/abstractview.cpp b/src/plugins/qmldesigner/designercore/model/abstractview.cpp
index b06c07dfca94e2be5aaa2891ff61f3e8045927a9..68bf75f7f0788997ab3fafec0f5fc5127c1dba4b 100644
--- a/src/plugins/qmldesigner/designercore/model/abstractview.cpp
+++ b/src/plugins/qmldesigner/designercore/model/abstractview.cpp
@@ -40,7 +40,8 @@ namespace QmlDesigner {
/*!
\class QmlDesigner::AbstractView
\ingroup CoreModel
-\brief An abstract interface views and editors can implement to be notified about model changes.
+\brief The AbstractView class provides an abstract interface that views and
+editors can implement to be notified about model changes.
\see QmlDesigner::WidgetQueryView, QmlDesigner::NodeInstanceView
*/
diff --git a/src/plugins/qmljstools/qmljsbundleprovider.cpp b/src/plugins/qmljstools/qmljsbundleprovider.cpp
index 77c0ee03b4b456756ab5162f204a8429c0e998e3..390618c2bbbee572c0c1d583855a4f2297059f5b 100644
--- a/src/plugins/qmljstools/qmljsbundleprovider.cpp
+++ b/src/plugins/qmljstools/qmljsbundleprovider.cpp
@@ -47,7 +47,8 @@ typedef QmlJS::QmlLanguageBundles QmlLanguageBundles;
/*!
\class QmlJSEditor::BasicBundleProvider
- \brief a class that sets up the default bundles for qt and various qml states.
+ \brief The BasicBundleProvider class sets up the default bundles for Qt and
+ various QML states.
*/
BasicBundleProvider::BasicBundleProvider(QObject *parent) :
IBundleProvider(parent)
diff --git a/src/plugins/texteditor/codeassist/iassistinterface.cpp b/src/plugins/texteditor/codeassist/iassistinterface.cpp
index 269dcaf6525e4c1c5d9edf58421024551e5fa3bb..dc4e23063b1e04737655c37786abceef7b5c5a98 100644
--- a/src/plugins/texteditor/codeassist/iassistinterface.cpp
+++ b/src/plugins/texteditor/codeassist/iassistinterface.cpp
@@ -33,8 +33,8 @@ using namespace TextEditor;
/*!
\class TextEditor::IAssistInterface
- \brief The IAssistInterface class acts as an interface for providing access to the document
- from which a proposal is computed.
+ \brief The IAssistInterface class acts as an interface for providing access
+ to the document from which a proposal is computed.
\ingroup CodeAssist
This interface existis in order to avoid a direct dependency on the text editor. This is
diff --git a/src/plugins/vcsbase/baseannotationhighlighter.cpp b/src/plugins/vcsbase/baseannotationhighlighter.cpp
index 613c2a7b902136390dce18c137ad4f0723aec48e..3a04647103d486f238add17a2b2380216c1c6c9b 100644
--- a/src/plugins/vcsbase/baseannotationhighlighter.cpp
+++ b/src/plugins/vcsbase/baseannotationhighlighter.cpp
@@ -39,7 +39,8 @@ typedef QMap<QString, QTextCharFormat> ChangeNumberFormatMap;
/*!
\class VcsBase::BaseAnnotationHighlighter
- \brief Base for a highlighter for annotation lines of the form 'changenumber:XXXX'.
+ \brief The BaseAnnotationHighlighter class is the base class for a
+ highlighter for annotation lines of the form 'changenumber:XXXX'.
The change numbers are assigned a color gradient. Example:
\code
diff --git a/src/plugins/vcsbase/basecheckoutwizard.cpp b/src/plugins/vcsbase/basecheckoutwizard.cpp
index 84d3e21ffd3c3b86f153ae2af8311faeca90b113..7999c6ea99891f8206ad8e8ae6e692c3069080f8 100644
--- a/src/plugins/vcsbase/basecheckoutwizard.cpp
+++ b/src/plugins/vcsbase/basecheckoutwizard.cpp
@@ -42,8 +42,8 @@
/*!
\class VcsBase::BaseCheckoutWizard
- \brief A Core::IWizard implementing a wizard for initially checking out a project using
- a version control system.
+ \brief The BaseCheckoutWizard class implements a wizard for initially
+ checking out a project using a version control system.
Implements all of Core::IWizard with the exception of
name()/description() and icon().
diff --git a/src/plugins/vcsbase/basecheckoutwizardpage.cpp b/src/plugins/vcsbase/basecheckoutwizardpage.cpp
index 9091829b269acd082c0e82c3d3d3250c8582adb7..ec212d9caae940422d99676be4155640066a720c 100644
--- a/src/plugins/vcsbase/basecheckoutwizardpage.cpp
+++ b/src/plugins/vcsbase/basecheckoutwizardpage.cpp
@@ -35,7 +35,8 @@
/*!
\class VcsBase::BaseCheckoutWizardPage
- \brief Base class for a parameter page of a checkout wizard.
+ \brief The BaseCheckoutWizardPage class is the base class for a parameter
+ page of a checkout wizard.
Lets the user specify the repository, a checkout directory and
the path. Contains a virtual to derive the checkout directory
diff --git a/src/plugins/vcsbase/basevcseditorfactory.cpp b/src/plugins/vcsbase/basevcseditorfactory.cpp
index 1d1565dee6b380eb4dcaefde53e18d0bc873288c..0d2780bf45d7da8ab9f86722ea4ff3e6f4e626b7 100644
--- a/src/plugins/vcsbase/basevcseditorfactory.cpp
+++ b/src/plugins/vcsbase/basevcseditorfactory.cpp
@@ -39,7 +39,8 @@
/*!
\class VcsBase::BaseVCSEditorFactory
- \brief Base class for editor factories creating instances of VcsBaseEditor subclasses.
+ \brief The BaseVCSEditorFactory class is the base class for editor
+ factories creating instances of VcsBaseEditor subclasses.
\sa VcsBase::VcsBaseEditorWidget
*/
diff --git a/src/plugins/vcsbase/checkoutjobs.cpp b/src/plugins/vcsbase/checkoutjobs.cpp
index 7b618ec625f265cd67f64f99713b088f91157632..6def0ade5f67012b279cb76748ad1b82f96e4d00 100644
--- a/src/plugins/vcsbase/checkoutjobs.cpp
+++ b/src/plugins/vcsbase/checkoutjobs.cpp
@@ -44,7 +44,9 @@ enum { debug = 0 };
/*!
\class VcsBase::AbstractCheckoutJob
- \brief Abstract base class for a job creating an initial project checkout.
+ \brief The AbstractCheckoutJob class is an abstract base class for a job
+ creating an initial project checkout.
+
It should be something that runs in the background producing log messages.
\sa VcsBase::BaseCheckoutWizard
@@ -104,7 +106,8 @@ AbstractCheckoutJob::AbstractCheckoutJob(QObject *parent) :
/*!
\class VcsBase::ProcessCheckoutJob
- \brief Convenience implementation of a VcsBase::AbstractCheckoutJob using a QProcess.
+ \brief The ProcessCheckoutJob class is a convenience implementation of a
+ VcsBase::AbstractCheckoutJob using a QProcess.
*/
ProcessCheckoutJob::ProcessCheckoutJob(QObject *parent) :
diff --git a/src/plugins/vcsbase/checkoutprogresswizardpage.cpp b/src/plugins/vcsbase/checkoutprogresswizardpage.cpp
index 02be689821de9d7d75f6b6f0e05bb28124870a31..157b07e1f486cb9f6f8757a12c4506cb7d443c31 100644
--- a/src/plugins/vcsbase/checkoutprogresswizardpage.cpp
+++ b/src/plugins/vcsbase/checkoutprogresswizardpage.cpp
@@ -38,8 +38,10 @@
/*!
\class VcsBase::CheckoutProgressWizardPage
- \brief Page showing the progress of an initial project checkout. Turns complete when the job
- succeeds.
+ \brief The CheckoutProgressWizardPage implements a page showing the
+ progress of an initial project checkout.
+
+ Turns complete when the job succeeds.
\sa VcsBase::BaseCheckoutWizard
*/
diff --git a/src/plugins/vcsbase/cleandialog.cpp b/src/plugins/vcsbase/cleandialog.cpp
index b5366102ae34125c5ab3afde42aa587eea173c29..73087c0bf478eb8cbb987875cb14313cbca89699 100644
--- a/src/plugins/vcsbase/cleandialog.cpp
+++ b/src/plugins/vcsbase/cleandialog.cpp
@@ -144,7 +144,8 @@ CleanDialogPrivate::CleanDialogPrivate() :
/*!
\class VcsBase::CleanDialog
- \brief File selector dialog for files not under version control.
+ \brief The CleanDialog class provides a file selector dialog for files not
+ under version control.
Completely clean a directory under version control
from all files that are not under version control based on a list
diff --git a/src/plugins/vcsbase/corelistener.cpp b/src/plugins/vcsbase/corelistener.cpp
index cf9d8d2a81df0df04b570c05e2e7b7f582285414..017d95b6f561f166acfbf2a759967e5a083f35de 100644
--- a/src/plugins/vcsbase/corelistener.cpp
+++ b/src/plugins/vcsbase/corelistener.cpp
@@ -33,7 +33,7 @@
/*!
\class VcsBase::Internal::CoreListener
- \brief CoreListener catching closing of a submit editor.
+ \brief The CoreListener class catches the closing of a submit editor.
Catch the closing of a submit editor to trigger the submit.
One instance of this class exists, connected to the instances
diff --git a/src/plugins/vcsbase/diffhighlighter.cpp b/src/plugins/vcsbase/diffhighlighter.cpp
index 464f399c397a7450d6c0d358fd407b023883c750..9a26fa5f58e595c2d05735e56bd1a1302a0dfc88 100644
--- a/src/plugins/vcsbase/diffhighlighter.cpp
+++ b/src/plugins/vcsbase/diffhighlighter.cpp
@@ -40,7 +40,7 @@
/*!
\class VcsBase::DiffHighlighter
- \brief A highlighter for diffs.
+ \brief The DiffHighlighter class provides a highlighter for diffs.
Parametrizable by the file indicator, which is for example '^====' in case of p4:
\code
diff --git a/src/plugins/vcsbase/nicknamedialog.cpp b/src/plugins/vcsbase/nicknamedialog.cpp
index 6630da56218c3771e591af05437a6926221fbd2d..8d64b29701cbf97d2ac7762d3d44e7a413b050b8 100644
--- a/src/plugins/vcsbase/nicknamedialog.cpp
+++ b/src/plugins/vcsbase/nicknamedialog.cpp
@@ -43,7 +43,7 @@ enum { NickNameRole = Qt::UserRole + 1 };
/*!
\class VcsBase::Internal::NickNameDialog
- \brief Show users from mail cap file.
+ \brief The NickNameDialog class shows users from a mail cap file.
Manages a list of users read from an extended
mail cap file, consisting of 4 columns: "Name Mail [AliasName [AliasMail]]".
diff --git a/src/plugins/vcsbase/submiteditorfile.cpp b/src/plugins/vcsbase/submiteditorfile.cpp
index 56e21af693fcd70c2d907082aac3399d3eab89b6..c07e604c1be200a4086017b09f41d68be471383b 100644
--- a/src/plugins/vcsbase/submiteditorfile.cpp
+++ b/src/plugins/vcsbase/submiteditorfile.cpp
@@ -35,7 +35,8 @@ using namespace VcsBase::Internal;
/*!
\class VcsBase::Internal::SubmitEditorFile
- \brief A non-saveable IDocument for submit editor files.
+ \brief The SubmitEditorFile class provides a non-saveable IDocument for
+ submit editor files.
*/
SubmitEditorFile::SubmitEditorFile(const QString &mimeType, QObject *parent) :
diff --git a/src/plugins/vcsbase/submiteditorwidget.cpp b/src/plugins/vcsbase/submiteditorwidget.cpp
index 928a8110f240a7d88d82ee16d82b4846eb87a795..192b9d5ccd7adf53c01cac76eaa0b45595eb57ab 100644
--- a/src/plugins/vcsbase/submiteditorwidget.cpp
+++ b/src/plugins/vcsbase/submiteditorwidget.cpp
@@ -50,7 +50,8 @@ enum { defaultLineWidth = 72 };
/*!
\class VcsBase::SubmitEditorWidget
- \brief Presents a VCS commit message in a text editor and a
+ \brief The SubmitEditorWidget class presents a VCS commit message in a text
+ editor and a
checkable list of modified files in a list window.
The user can delete files from the list by unchecking them or diff the selection
diff --git a/src/plugins/vcsbase/submitfieldwidget.cpp b/src/plugins/vcsbase/submitfieldwidget.cpp
index 61d629e7012cbdeb618f27ce68a235f2a9cc6457..a0df616cf01e66e9d51bc5bedb7007b1af130214 100644
--- a/src/plugins/vcsbase/submitfieldwidget.cpp
+++ b/src/plugins/vcsbase/submitfieldwidget.cpp
@@ -53,7 +53,8 @@ static void inline setComboBlocked(QComboBox *cb, int index)
/*!
\class VcsBase::SubmitFieldWidget
- \brief A widget for editing submit message fields like "reviewed-by:",
+ \brief The SubmitFieldWidget class is a widget for editing submit message
+ fields like "reviewed-by:",
"signed-off-by:".
It displays them in a vertical row of combo/line edit fields
diff --git a/src/plugins/vcsbase/submitfilemodel.cpp b/src/plugins/vcsbase/submitfilemodel.cpp
index 5c9eee854dfe2a0c6a094efae597081867932d56..2bc7f75febb47dc0282ffda71d22c68563a6e08d 100644
--- a/src/plugins/vcsbase/submitfilemodel.cpp
+++ b/src/plugins/vcsbase/submitfilemodel.cpp
@@ -70,8 +70,10 @@ static QList<QStandardItem *> createFileRow(const QString &fileName, const QStri
/*!
\class VcsBase::SubmitFileModel
- \brief A 2-column (checkable, state, file name) model to be used to list the files
- in the submit editor. Provides header items and a convience to add files.
+ \brief The SubmitFileModel class is a 2-column (checkable, state, file name)
+ model to be used to list the files in the submit editor.
+
+ Provides header items and a convenience function to add files.
*/
SubmitFileModel::SubmitFileModel(QObject *parent) :
diff --git a/src/plugins/vcsbase/vcsbaseclient.cpp b/src/plugins/vcsbase/vcsbaseclient.cpp
index dfa3acd7d30076a2c85397e6d7880a508d435194..e6652842b4b36c5c48dd221c3802bf86db5b12b0 100644
--- a/src/plugins/vcsbase/vcsbaseclient.cpp
+++ b/src/plugins/vcsbase/vcsbaseclient.cpp
@@ -55,7 +55,8 @@
/*!
\class VcsBase::VcsBaseClient
- \brief Base class for Mercurial and Bazaar 'clients'.
+ \brief The VcsBaseClient class is the base class for Mercurial and Bazaar
+ 'clients'.
Provides base functionality for common commands (diff, log, etc).
diff --git a/src/plugins/vcsbase/vcsbaseclientsettings.cpp b/src/plugins/vcsbase/vcsbaseclientsettings.cpp
index 5e56da91f5818e752b0863f20da00dfb1e4b0e27..a5eaae69f546c2df6b87cfcb7f3704868e638108 100644
--- a/src/plugins/vcsbase/vcsbaseclientsettings.cpp
+++ b/src/plugins/vcsbase/vcsbaseclientsettings.cpp
@@ -184,7 +184,8 @@ public:
/*!
\class VcsBase::VcsBaseClientSettings
- \brief Settings used in VcsBaseClient.
+ \brief The VcsBaseClientSettings class contains settings used in
+ VcsBaseClient.
\sa VcsBase::VcsBaseClient
*/
diff --git a/src/plugins/vcsbase/vcsbaseeditor.cpp b/src/plugins/vcsbase/vcsbaseeditor.cpp
index 321cca7e32d71b4e3346238afaa47576c63c51a2..247ff8e589fc43e856100a6f2c6f462bacf7c460 100644
--- a/src/plugins/vcsbase/vcsbaseeditor.cpp
+++ b/src/plugins/vcsbase/vcsbaseeditor.cpp
@@ -89,7 +89,8 @@ namespace VcsBase {
/*!
\class VcsBase::DiffChunk
- \brief A diff chunk consisting of file name and chunk data.
+ \brief The DiffChunk class provides a diff chunk consisting of file name
+ and chunk data.
*/
bool DiffChunk::isValid() const
@@ -132,7 +133,8 @@ namespace VcsBase {
/*!
\class VcsBase::VcsBaseEditor
- \brief An editor with no support for duplicates.
+ \brief The VcsBaseEditor class implements an editor with no support for
+ duplicates.
Creates a browse combo in the toolbar for diff output.
It also mirrors the signals of the VcsBaseEditor since the editor
@@ -173,7 +175,8 @@ VcsBaseEditor::VcsBaseEditor(VcsBaseEditorWidget *widget,
namespace Internal {
/*! \class AbstractTextCursorHandler
- * \brief Provides an interface to handle the contents under a text cursor inside an editor
+ * \brief The AbstractTextCursorHandler class provides an interface to handle
+ * the contents under a text cursor inside an editor.
*/
class AbstractTextCursorHandler : public QObject
{
@@ -238,7 +241,8 @@ QTextCursor AbstractTextCursorHandler::currentCursor() const
}
/*! \class ChangeTextCursorHandler
- * \brief Provides a handler for VCS change identifiers
+ * \brief The ChangeTextCursorHandler class provides a handler for VCS change
+ * identifiers.
*/
class ChangeTextCursorHandler : public AbstractTextCursorHandler
{
@@ -368,7 +372,8 @@ QAction *ChangeTextCursorHandler::createCopyRevisionAction(const QString &change
}
/*! \class UrlTextCursorHandler
- * \brief Provides a handler for URL like http://qt-project.org/
+ * \brief The UrlTextCursorHandler class provides a handler for URLs, such as
+ * http://qt-project.org/.
*
* The URL pattern can be redefined in sub-classes with setUrlPattern(), by default the pattern
* works for hyper-text URL
@@ -507,7 +512,8 @@ QAction *UrlTextCursorHandler::createCopyUrlAction(const QString &text) const
}
/*! \class EmailTextCursorHandler
- * \brief Provides a handler for email addresses
+ * \brief The EmailTextCursorHandler class provides a handler for email
+ * addresses.
*/
class EmailTextCursorHandler : public UrlTextCursorHandler
{
@@ -618,10 +624,13 @@ QComboBox *VcsBaseEditorWidgetPrivate::entriesComboBox()
} // namespace Internal
/*!
- \struct VcsBase::VcsBaseEditorParameters
+ \class VcsBase::VcsBaseEditorParameters
- \brief Helper struct used to parametrize an editor with mime type, context
- and id. The extension is currently only a suggestion when running
+ \brief The VcsBaseEditorParameters class is a helper class used to
+ parametrize an editor with MIME type, context
+ and id.
+
+ The extension is currently only a suggestion when running
VCS commands with redirection.
\sa VcsBase::VcsBaseEditorWidget, VcsBase::BaseVcsEditorFactory, VcsBase::EditorContentType
@@ -630,7 +639,8 @@ QComboBox *VcsBaseEditorWidgetPrivate::entriesComboBox()
/*!
\class VcsBase::VcsBaseEditorWidget
- \brief Base class for editors showing version control system output
+ \brief The VcsBaseEditorWidget class is the base class for editors showing
+ version control system output
of the type enumerated by EditorContentType.
The source property should contain the file or directory the log
diff --git a/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp b/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp
index 1b162d251ffa4a1728a8bdaeeede9ecfe67a3ba6..743feb2cf38123827626ee313c56e0beb9a56472 100644
--- a/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp
+++ b/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp
@@ -96,7 +96,8 @@ public:
/*!
\class VcsBase::VcsBaseEditorParameterWidget
- \brief A toolbar-like widget for use with VcsBase::VcsBaseEditor::setConfigurationWidget()
+ \brief The VcsBaseEditorParameterWidget is a toolbar-like widget for use
+ with VcsBase::VcsBaseEditor::setConfigurationWidget()
influencing for example the generation of VCS diff output.
The widget maintains a list of command line arguments (starting from baseArguments())
diff --git a/src/plugins/vcsbase/vcsbaseoptionspage.cpp b/src/plugins/vcsbase/vcsbaseoptionspage.cpp
index de07fb1e3e0d804008688579ba846c49829ccaa7..f6256d0b4932ce8d89462434288588411a4bbf11 100644
--- a/src/plugins/vcsbase/vcsbaseoptionspage.cpp
+++ b/src/plugins/vcsbase/vcsbaseoptionspage.cpp
@@ -36,7 +36,8 @@
/*!
\class VcsBase::VcsBaseOptionsPage
- \brief Base class for VCS options pages providing common category/icon.
+ \brief The VcsBaseOptionsPage class is the base class for VCS options pages
+ providing a common category and icon.
*/
namespace VcsBase {
diff --git a/src/plugins/vcsbase/vcsbaseoutputwindow.cpp b/src/plugins/vcsbase/vcsbaseoutputwindow.cpp
index 9dd32497ed7d6d5c4363dc673f8f726015b4c3a4..96ced2c7ff0a6705cdf5a6f32ec9c3ae8a862a65 100644
--- a/src/plugins/vcsbase/vcsbaseoutputwindow.cpp
+++ b/src/plugins/vcsbase/vcsbaseoutputwindow.cpp
@@ -50,7 +50,8 @@
/*!
\class VcsBase::VcsBaseOutputWindow
- \brief Output window for Version Control System command and other output (Singleton).
+ \brief The VcsBaseOutputWindow class is an output window for Version Control
+ System commands and other output (Singleton).
Installed by the base plugin and accessible for the other plugins
via static instance()-accessor. Provides slots to append output with
diff --git a/src/plugins/vcsbase/vcsbaseplugin.cpp b/src/plugins/vcsbase/vcsbaseplugin.cpp
index 05c51a8aa348d79e71e63986a8b1aea62f5a7fa4..3263da69af2cfb504817500e808019c31b018dbb 100644
--- a/src/plugins/vcsbase/vcsbaseplugin.cpp
+++ b/src/plugins/vcsbase/vcsbaseplugin.cpp
@@ -63,12 +63,13 @@ enum { debug = 0, debugRepositorySearch = 0, debugExecution = 0 };
/*!
\namespace VcsBase
- \brief VcsBase plugin namespace
+ \brief The VcsBase namespace contains classes for the VcsBase plugin.
*/
/*!
\namespace VcsBase::Internal
- \brief Internal namespace of the VcsBase plugin
+ \brief The Internal namespace contains internal classes for the VcsBase
+ plugin.
\internal
*/
@@ -76,9 +77,10 @@ namespace VcsBase {
namespace Internal {
/*!
- \struct VcsBase::Internal::State
+ \class VcsBase::Internal::State
- \brief Internal state created by the state listener and VcsBasePluginState.
+ \brief The State class provides the internal state created by the state
+ listener and VcsBasePluginState.
Aggregated in the QSharedData of VcsBase::VcsBasePluginState.
*/
@@ -179,7 +181,8 @@ QDebug operator<<(QDebug in, const State &state)
/*!
\class VcsBase::Internal::StateListener
- \brief Connects to the relevant signals of Qt Creator, tries to find version
+ \brief The StateListener class connects to the relevant signals of \QC,
+ tries to find version
controls and emits signals to the plugin instances.
Singleton (as not to do checks multiple times).
@@ -305,7 +308,8 @@ public:
/*!
\class VcsBase::VcsBasePluginState
- \brief Relevant state information of the VCS plugins
+ \brief The VcsBasePluginState class provides relevant state information
+ about the VCS plugins.
Qt Creator's state relevant to VCS plugins is a tuple of
@@ -455,7 +459,8 @@ VCSBASE_EXPORT QDebug operator<<(QDebug in, const VcsBasePluginState &state)
/*!
\class VcsBase::VcsBasePlugin
- \brief Base class for all version control plugins.
+ \brief The VcsBasePlugin class is the base class for all version control
+ plugins.
The plugin connects to the
relevant change signals in Qt Creator and calls the virtual
diff --git a/src/plugins/vcsbase/vcsbasesubmiteditor.cpp b/src/plugins/vcsbase/vcsbasesubmiteditor.cpp
index b4c7e3e2d5cd833842a449f11f2892ef2834014a..e8c1cfd1d9e0b80b0576fef1904e12863b427f30 100644
--- a/src/plugins/vcsbase/vcsbasesubmiteditor.cpp
+++ b/src/plugins/vcsbase/vcsbasesubmiteditor.cpp
@@ -97,15 +97,17 @@ static const char *belongingClassName(const CPlusPlus::Function *function)
}
/*!
- \struct VcsBase::VcsBaseSubmitEditorParameters
+ \class VcsBase::VcsBaseSubmitEditorParameters
- \brief Utility struct to parametrize a VcsBaseSubmitEditor.
+ \brief The VcsBaseSubmitEditorParameters class is a utility class
+ to parametrize a VcsBaseSubmitEditor.
*/
/*!
\class VcsBase::VcsBaseSubmitEditor
- \brief Base class for a submit editor based on the SubmitEditorWidget.
+ \brief The VcsBaseSubmitEditor class is the base class for a submit editor
+ based on the SubmitEditorWidget.
Presents the commit message in a text editor and an
checkable list of modified files in a list window. The user can delete