diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-10 17:16:10 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-11 10:02:01 +0200 |
| commit | 6b99d2bb7857cac2eb8f3b5f00ab575414d1b86a (patch) | |
| tree | 997562c7c6a9b5715eba71fabf9097d79fda410e /src/plugins/projectexplorer/project.cpp | |
| parent | c5c501669fad9adce4a7628847ed352a1c098038 (diff) | |
| download | qt-creator-6b99d2bb7857cac2eb8f3b5f00ab575414d1b86a.tar.gz | |
Doc: edit projectexplorer API docs
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>
Diffstat (limited to 'src/plugins/projectexplorer/project.cpp')
| -rw-r--r-- | src/plugins/projectexplorer/project.cpp | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/plugins/projectexplorer/project.cpp b/src/plugins/projectexplorer/project.cpp index a66fdc32c1..ac10056b82 100644 --- a/src/plugins/projectexplorer/project.cpp +++ b/src/plugins/projectexplorer/project.cpp @@ -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 |