Doc: edit macros documentation

Edit to use standard wording.
Use \a commands for attributes.

Change-Id: I90262bc12fe601df81c33a9a49cc8d0e8005407e
Reviewed-by: Eike Ziller <eike.ziller@digia.com>

3 files changed, 14 insertions, 13 deletions

diff --git a/src/plugins/macros/imacrohandler.cpp b/src/plugins/macros/imacrohandler.cpp
index e0d1a4cfe3..5b5a9850c1 100644
--- a/src/plugins/macros/imacrohandler.cpp
+++ b/src/plugins/macros/imacrohandler.cpp
@@ -38,35 +38,36 @@ using namespace Macros;
     \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 a345f06e20..0443e850e6 100644
--- a/src/plugins/macros/macro.cpp
+++ b/src/plugins/macros/macro.cpp
@@ -44,8 +44,8 @@ using namespace Macros;
     \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 002a12427d..bb93e12fab 100644
--- a/src/plugins/macros/macromanager.cpp
+++ b/src/plugins/macros/macromanager.cpp
@@ -75,8 +75,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
@@ -90,7 +90,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.
 */