From 40979a2c81f28ccd165982bd137c25a94f34c4cc Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Mon, 24 Dec 2018 13:50:02 +0900 Subject: Clarify doc-comment for BaseJob::finished a bit [skip ci] --- lib/jobs/basejob.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'lib/jobs') 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 * -- cgit v1.2.3