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

Doc: edit coreplugin docs

Browse Source 
Remove \brief commands for functions.
Use standard wording for QDoc commands.
Fix style and grammar issues.
Use the \a command instead of the \c command for attributes
in function descriptions.
Do not use \returns, because it does not exist.

Change-Id: Icd32b519670cb376e246bab3a58fe7e98d2529ea
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-06 16:38:53 +02:00
committed by Eike Ziller
parent 65f0588196
commit 120bf88eab
14 changed files with 281 additions and 243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/plugins/coreplugin/id.cpp
View File

@@ -54,7 +54,7 @@ namespace Core {
and associated with a plain 7-bit-clean ASCII name used
for display and persistency.
Each plugin that is distributed as part of Qt Creator has a
Each plugin that is distributed as part of \QC has a
private range of 10000 UIDs that are guaranteed to be unique.
Third party plugins are advised to construct ids from their
@@ -137,10 +137,10 @@ static int theId(const QByteArray &ba)
/*!
\fn Core::Id(int uid)
\brief Constructs an id given a UID.
Constructs an id given \a UID.
The UID is an integer value that is unique within the running
Qt Creator process.
\QC process.
It is the callers responsibility to ensure the uniqueness of
the passed integer. The recommended approach is to use
@@ -152,9 +152,9 @@ static int theId(const QByteArray &ba)
*/
/*!
Constructs an id given its associated name. The internal
Constructs an id given its associated \a name. The internal
representation will be unspecified, but consistent within a
Qt Creator process.
\QC process.
*/
Id::Id(const char *name)
@@ -248,7 +248,7 @@ Id Id::fromSetting(const QVariant &variant)
This can be used to construct groups of ids logically
belonging together. The associated internal name
will be generated by appending \c{suffix}.
will be generated by appending \a suffix.
*/
Id Id::withSuffix(int suffix) const
@@ -284,7 +284,7 @@ Id Id::withSuffix(const QString &suffix) const
This can be used to construct groups of ids logically
belonging together. The associated internal name
will be generated by prepending \c{prefix}.
will be generated by prepending \a prefix.
*/
Id Id::withPrefix(const char *prefix) const
@@ -332,9 +332,9 @@ bool Id::alphabeticallyBefore(Id other) const
/*!
Convenience function to extract a part of the id string
representation. This can be used to split off the base
part used when generating an id with \c{withSuffix()}.
Extracts a part of the id string
representation. This function can be used to split off the base
part specified by \a baseId used when generating an id with \c{withSuffix()}.
\sa withSuffix()
*/