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/processparameters.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/processparameters.cpp')
| -rw-r--r-- | src/plugins/projectexplorer/processparameters.cpp | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/src/plugins/projectexplorer/processparameters.cpp b/src/plugins/projectexplorer/processparameters.cpp index 649225361d..504c5effda 100644 --- a/src/plugins/projectexplorer/processparameters.cpp +++ b/src/plugins/projectexplorer/processparameters.cpp @@ -57,7 +57,7 @@ ProcessParameters::ProcessParameters() : } /*! - \brief Sets the executable to run. + Sets the executable to run. */ void ProcessParameters::setCommand(const QString &cmd) @@ -67,7 +67,7 @@ void ProcessParameters::setCommand(const QString &cmd) } /*! - \brief Sets the command line arguments used by the process + Sets the command line arguments used by the process. */ void ProcessParameters::setArguments(const QString &arguments) @@ -77,8 +77,9 @@ void ProcessParameters::setArguments(const QString &arguments) } /*! - \brief Sets the workingDirectory for the process for a buildConfiguration - should be called from init() + Sets the \a workingDirectory for the process for a build configuration. + + Should be called from init(). */ void ProcessParameters::setWorkingDirectory(const QString &workingDirectory) @@ -89,20 +90,21 @@ void ProcessParameters::setWorkingDirectory(const QString &workingDirectory) /*! \fn void ProjectExplorer::ProcessParameters::setEnvironment(const Utils::Environment &env) - \brief Set the Environment for running the command + Sets the environment \a env for running the command. - Should be called from init() + Should be called from init(). */ /*! \fn void ProjectExplorer::ProcessParameters::setMacroExpander(Utils::AbstractMacroExpander *mx) - \brief Set the macro expander to use on the command, arguments and working dir. + Sets the macro expander \a mx to use on the command, arguments, and working + dir. - Note that the caller retains ownership of the object. + \note The caller retains ownership of the object. */ /*! - \brief Get the fully expanded working directory. + Gets the fully expanded working directory. */ QString ProcessParameters::effectiveWorkingDirectory() const @@ -117,7 +119,7 @@ QString ProcessParameters::effectiveWorkingDirectory() const } /*! - \brief Get the fully expanded command name to run + Gets the fully expanded command name to run. */ QString ProcessParameters::effectiveCommand() const @@ -136,7 +138,7 @@ QString ProcessParameters::effectiveCommand() const } /*! - \brief True if effectiveCommand() would return only a fallback. + Returns \c true if effectiveCommand() would return only a fallback. */ bool ProcessParameters::commandMissing() const |