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:
@@ -42,9 +42,9 @@ namespace Utils {
|
||||
|
||||
/*! \class Utils::FileUtils
|
||||
|
||||
\brief File- and directory-related convenience functions.
|
||||
\brief The FileUtils class contains file and directory related convenience
|
||||
functions.
|
||||
|
||||
File- and directory-related convenience functions.
|
||||
*/
|
||||
|
||||
/*!
|
||||
@@ -411,7 +411,7 @@ TempFileSaver::~TempFileSaver()
|
||||
|
||||
/*! \class Utils::FileName
|
||||
|
||||
\brief A light-weight convenience class for filenames
|
||||
\brief The FileName class is a light-weight convenience class for filenames.
|
||||
|
||||
On windows filenames are compared case insensitively.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user