diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/plugins/coreplugin/basefilewizard.cpp | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
| download | qt-creator-41411165bac561d3cd93a793c6ae76dcb2937e12.tar.gz | |
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>
Diffstat (limited to 'src/plugins/coreplugin/basefilewizard.cpp')
| -rw-r--r-- | src/plugins/coreplugin/basefilewizard.cpp | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/plugins/coreplugin/basefilewizard.cpp b/src/plugins/coreplugin/basefilewizard.cpp index d0c9d91718..74d49cef36 100644 --- a/src/plugins/coreplugin/basefilewizard.cpp +++ b/src/plugins/coreplugin/basefilewizard.cpp @@ -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. |