diff options
| author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2018-12-24 13:50:02 +0900 |
|---|---|---|
| committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2018-12-24 13:50:02 +0900 |
| commit | 40979a2c81f28ccd165982bd137c25a94f34c4cc (patch) | |
| tree | dfe7aa31747a121fa0d6f7351790fc776c729ff3 /lib/jobs | |
| parent | 3bf592eff94f4a2d3e9094d74b7462214ee0b341 (diff) | |
| download | libquotient-40979a2c81f28ccd165982bd137c25a94f34c4cc.tar.gz libquotient-40979a2c81f28ccd165982bd137c25a94f34c4cc.zip | |
Clarify doc-comment for BaseJob::finished a bit
[skip ci]
Diffstat (limited to 'lib/jobs')
| -rw-r--r-- | lib/jobs/basejob.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/jobs/basejob.h b/lib/jobs/basejob.h index 3d50344d..dd6f9fc8 100644 --- a/lib/jobs/basejob.h +++ b/lib/jobs/basejob.h @@ -215,9 +215,9 @@ namespace QMatrixClient * * In general, to be notified of a job's completion, client code * should connect to result(), success(), or failure() - * rather than finished(). However if you store a list of jobs - * and need to track their lifecycle, then you should connect to this - * instead of result(), to avoid dangling pointers in your list. + * rather than finished(). However if you need to track the job's + * lifecycle you should connect to this instead of result(); + * in particular, only this signal will be emitted on abandoning. * * @param job the job that emitted this signal * |