aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/macros
diff options
context:
space:
mode:
authorEike Ziller <eike.ziller@digia.com>2013-09-27 10:44:32 +0200
committerEike Ziller <eike.ziller@digia.com>2013-09-27 10:44:32 +0200
commit63ff7452137958215988d9f2f6066de955500be0 (patch)
treed645a26ae9db68cdbf37e9fd997a221c81eea008 /src/plugins/macros
parent19c735a4912487e8038f08ea0b617ccce62cd1a3 (diff)
parenta12a9f491cb31ff5c22f1051bb22ccfef6c65217 (diff)
Merge remote-tracking branch 'origin/2.8'
Conflicts: src/libs/extensionsystem/pluginmanager.cpp src/libs/extensionsystem/pluginspec.cpp src/plugins/coreplugin/basefilewizard.cpp src/plugins/coreplugin/coreplugin.pro src/plugins/coreplugin/coreplugin.qbs src/plugins/coreplugin/editormanager/ieditor.cpp src/plugins/coreplugin/externaltool.cpp src/plugins/coreplugin/icore.cpp src/plugins/cpptools/cppmodelmanager.cpp src/plugins/fakevim/fakevimhandler.cpp src/plugins/find/ifindfilter.cpp src/plugins/projectexplorer/buildstep.cpp src/plugins/projectexplorer/devicesupport/idevice.cpp src/plugins/projectexplorer/runconfiguration.cpp src/plugins/vcsbase/vcsbaseeditor.cpp tests/system/suite_debugger/tst_simple_analyze/test.py Change-Id: I11dc9e60bfc14bad4f8af747d041fc7678a07c17
Diffstat (limited to 'src/plugins/macros')
-rw-r--r--src/plugins/macros/imacrohandler.cpp17
-rw-r--r--src/plugins/macros/macro.cpp4
-rw-r--r--src/plugins/macros/macromanager.cpp6
3 files changed, 14 insertions, 13 deletions
diff --git a/src/plugins/macros/imacrohandler.cpp b/src/plugins/macros/imacrohandler.cpp
index b6a145c375..25630a24ae 100644
--- a/src/plugins/macros/imacrohandler.cpp
+++ b/src/plugins/macros/imacrohandler.cpp
@@ -38,35 +38,36 @@ using namespace Macros::Internal;
\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
+ They are used to create and replay macro events. Use
+ MacroManager::registerEventHandler
to add a new event handler.
*/
/*!
\fn void IEventHandler::startRecording(Macro* macro)
- This method is called when starting to record a macro, it can be used
- to initialize some data.
+ Initializes some data when starting to record a macro.
*/
/*!
\fn void IEventHandler::endRecordingMacro(Macro* macro)
- This method is called after recording a macro, to cleanup everything.
+ Cleans up after recording a macro.
*/
/*!
\fn bool IEventHandler::canExecuteEvent(const MacroEvent &macroEvent)
- When replaying a macro, the manager iterate through all macro events
- in the macro and call this method to know which handler to use.
- If the method returns true, executeEvent is called.
+ When replaying a macro, the manager iterates through all macro events
+ specified in \a macroEvent
+ in the macro and calls this method to determine which handler to use.
+ If the method returns \c true, \c executeEvent is called.
*/
/*!
\fn bool IEventHandler::executeEvent(const MacroEvent &macroEvent)
- This method execute a specific macro event, using the values stored in
+ Executes the specified \a macroEvent, using the values stored in
the macro event.
*/
diff --git a/src/plugins/macros/macro.cpp b/src/plugins/macros/macro.cpp
index e14907625b..4f7e174626 100644
--- a/src/plugins/macros/macro.cpp
+++ b/src/plugins/macros/macro.cpp
@@ -44,8 +44,8 @@ using namespace Macros::Internal;
\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
+ A macro is a list of events that can be replayed in \QC. A macro has
+ an header consisting of the \QC version where the macro was created
and a description.
The name of the macro is the filename without the extension.
*/
diff --git a/src/plugins/macros/macromanager.cpp b/src/plugins/macros/macromanager.cpp
index 32a57c418d..8e57644486 100644
--- a/src/plugins/macros/macromanager.cpp
+++ b/src/plugins/macros/macromanager.cpp
@@ -74,8 +74,8 @@ using namespace Macros::Internal;
\class Macro::MacroManager
\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.
+ The MacroManager manages all macros, loads them on startup, keeps track of the
+ current macro, and creates new macros.
There are two important methods in this class that can be used outside the Macros plugin:
\list
@@ -89,7 +89,7 @@ using namespace Macros::Internal;
/*!
\fn void registerAction(QAction *action, const QString &id)
- Append this action to the list of actions registered in a macro. The id is
+ Appends \a action to the list of actions registered in a macro. \a id is
the action id passed to the ActionManager.
*/