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/extensionsystem/pluginspec.cpp
View File

@@ -63,7 +63,8 @@
/*!
\class ExtensionSystem::PluginDependency
\brief Struct that contains the name and required compatible version number of a plugin's dependency.
\brief The PluginDependency class contains the name and required compatible
version number of a plugin's dependency.
This reflects the data of a dependency tag in the plugin's xml description file.
The name and version are used to resolve the dependency, i.e. a plugin with the given name and
@@ -102,7 +103,8 @@
/*!
\class ExtensionSystem::PluginSpec
\brief Contains the information of the plugins xml description file and
\brief The PluginSpec class contains the information of the plugin's XML
description file and
information about the plugin's current state.
The plugin spec is also filled with more information as the plugin