aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/macros/macroevent.cpp
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2013-06-05 14:29:24 +0200
committerLeena Miettinen <riitta-leena.miettinen@digia.com>2013-06-20 11:22:47 +0200
commit41411165bac561d3cd93a793c6ae76dcb2937e12 (patch)
treecc9e5e516899407448ad8eadd207909ee3115493 /src/plugins/macros/macroevent.cpp
parent440725322abf0189c0cb28baddebe76bc26c5f05 (diff)
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>
Diffstat (limited to 'src/plugins/macros/macroevent.cpp')
-rw-r--r--src/plugins/macros/macroevent.cpp3
1 files changed, 1 insertions, 2 deletions
diff --git a/src/plugins/macros/macroevent.cpp b/src/plugins/macros/macroevent.cpp
index 1accf69531..9c7aae96da 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).