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:
@@ -45,7 +45,8 @@ namespace Utils {
|
||||
|
||||
/*! \class Utils::FancyMainWindow
|
||||
|
||||
\brief MainWindow with dock widgets and additional "lock" functionality
|
||||
\brief The FancyMainWindow class is a MainWindow with dock widgets and
|
||||
additional "lock" functionality
|
||||
(locking the dock widgets in place) and "reset layout" functionality.
|
||||
|
||||
The dock actions and the additional actions should be accessible
|
||||
|
||||
Reference in New Issue
Block a user