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>
This commit is contained in:
Leena Miettinen
2013-09-06 17:23:10 +02:00
committed by Eike Ziller
parent 120bf88eab
commit 0c6636d291
3 changed files with 14 additions and 13 deletions

View File

@@ -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.
*/