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

Doc: edit projectexplorer API docs

Browse Source 
Fix grammar, punctuation, and style issues. Use standard wording for
QDoc commands. Remove \brief commands from function descriptions.
Move some function descriptions directly above the functions, so
that the \fn command can be removed.

Change-Id: Iedf4f0041af24541a982241f99bd4906e86af916
Reviewed-by: Daniel Teske <daniel.teske@digia.com>
This commit is contained in:
Leena Miettinen
2013-09-10 17:16:10 +02:00
parent c5c501669f
commit 6b99d2bb78
16 changed files with 213 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/plugins/projectexplorer/project.cpp
View File

@@ -51,15 +51,17 @@
/*!
\fn void ProjectExplorer::Project::environmentChanged()
\brief Convenience signal emitted if the activeBuildConfiguration emits environmentChanged
or if the activeBuildConfiguration changes (including due to the active target changing).
A convenience signal emitted if activeBuildConfiguration emits
environmentChanged or if the active build configuration changes
(including due to the active target changing).
*/
/*!
\fn void ProjectExplorer::Project::buildConfigurationEnabledChanged()
\brief Convenience signal emitted if the activeBuildConfiguration emits isEnabledChanged()
or if the activeBuildConfiguration changes (including due to the active target changing).
A convenience signal emitted if activeBuildConfiguration emits
isEnabledChanged() or if the active build configuration changes
(including due to the active target changing).
*/
namespace {
@@ -300,14 +302,14 @@ bool Project::restoreSettings()
/*!
\brief Serialize all data into a QVariantMap.
Serializes all data into a QVariantMap.
This map is then saved in the .user file of the project.
Just put all your data into the map.
\note Do not forget to call your base class' toMap method.
\note Do not forget to call setActiveBuildConfiguration when
creating new BuilConfigurations.
creating new build configurations.
*/
QVariantMap Project::toMap() const