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:
@@ -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).
|
||||
|
||||
Reference in New Issue
Block a user