diff options
author | kh <karsten.heimrich@theqtcompany.com> | 2014-11-25 16:00:24 +0100 |
---|---|---|
committer | Niels Weber <niels.weber@theqtcompany.com> | 2014-12-01 15:51:39 +0100 |
commit | a439e6fab484461744a657f5173a738622064edf (patch) | |
tree | fb91ee0093cf27e7b049a75938ffbf52d498b191 /src/libs/kdtools/kdjob.cpp | |
parent | 579d562e25bacbf169cab30976f0e8b0e42b849f (diff) |
Documentation updates and fixes.
Change-Id: Ie9fc9e1c2a0b84082cb48732e270913bc90d9a79
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Diffstat (limited to 'src/libs/kdtools/kdjob.cpp')
-rw-r--r-- | src/libs/kdtools/kdjob.cpp | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/src/libs/kdtools/kdjob.cpp b/src/libs/kdtools/kdjob.cpp index cb9f2ebef..0a0636fa8 100644 --- a/src/libs/kdtools/kdjob.cpp +++ b/src/libs/kdtools/kdjob.cpp @@ -212,8 +212,8 @@ void KDJob::setTotalAmount(quint64 amount) } /*! - Returns the timeout in milliseconds before the jobs cancel slot gets triggered. A return value of -1 - means there is currently no timeout used for the job. + Returns the timeout in milliseconds before the job's cancel slot gets triggered. A return value + of -1 means there is currently no timeout used for the job. */ int KDJob::timeout() const { @@ -221,10 +221,9 @@ int KDJob::timeout() const } /*! - Sets the timeout in \a milliseconds before the jobs cancel slot gets triggered. \note Only jobs that - have the \c KDJob::Cancelable capability can be canceled by a timeout. A - value of -1 will stop the - timeout mechanism. + Sets the timeout in \a milliseconds before the job's cancel slot gets triggered. \note Only jobs + that have the \c KDJob::Cancelable capability can be canceled by a timeout. A value of -1 will + stop the timeout mechanism. */ void KDJob::setTimeout(int milliseconds) { |