forked from qt-creator/qt-creator
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces and \brief commands, so the following wording must be used: "The xxx class yyy ..." Change-Id: Id231f30e8464898b776888d5423523de404aae34 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user