feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: use standard wording in \brief commands

Browse Source 
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:
Leena Miettinen
2013-06-05 14:29:24 +02:00
parent 440725322a
commit 41411165ba
162 changed files with 486 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/libs/utils/persistentsettings.cpp
View File

@@ -43,7 +43,8 @@
/*!
\class Utils::PersistentSettingsReader
\brief Reads a QVariantMap of arbitrary, nested data structures from a XML file.
\brief The PersistentSettingsReader class reads a QVariantMap of arbitrary,
nested data structures from an XML file.
Handles all string-serializable simple types and QVariantList and QVariantMap. Example:
\code
@@ -321,7 +322,8 @@ bool PersistentSettingsReader::load(const Utils::FileName &fileName)
/*!
\class Utils::PersistentSettingsWriter
\brief Serializes a QVariantMap of arbitrary, nested data structures to a XML file.
\brief The PersistentSettingsWriter class serializes a QVariantMap of
arbitrary, nested data structures to an XML file.
\sa Utils::PersistentSettingsReader
*/