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

11
src/plugins/coreplugin/basefilewizard.cpp
View File

@@ -100,8 +100,9 @@ void BaseFileWizardParameterData::clear()
/*!
\class Core::BaseFileWizardParameters
\brief Parameter class for passing parameters to instances of class Wizard
containing name, icon and such.
\brief The BaseFileWizardParameters class is a parameter class for
passing parameters to instances of the class Wizard containing name, icon,
and so on.
\sa Core::GeneratedFile, Core::BaseFileWizard, Core::StandardFileWizard
\sa Core::Internal::WizardEventLoop
@@ -341,7 +342,8 @@ void WizardEventLoop::rejected()
/*!
\class Core::BaseFileWizard
\brief A generic wizard for creating files.
\brief The BaseFileWizard class implements a generic wizard for
creating files.
The abstract methods:
\list
@@ -781,7 +783,8 @@ QString BaseFileWizard::preferredSuffix(const QString &mimeType)
/*!
\class Core::StandardFileWizard
\brief Convenience class for creating one file.
\brief The StandardFileWizard class is a convenience class for
creating one file.
It uses Utils::FileWizardDialog and introduces a new virtual to generate the
files from path and name.