qt,doc: Document that Job::startIt() doesn't self-destruct Job on error

-- GnuPG-bug-id: 6550
2023-12-22 10:07:11 +01:00 · 2023-12-22 10:07:11 +01:00 · 0b3c8709f7
commit 0b3c8709f7
parent e77a8ac0cc
1 changed files with 4 additions and 1 deletions
--- a/lang/qt/src/job.h
+++ b/lang/qt/src/job.h
@ -97,7 +97,10 @@ public:

    /** Starts the job.
     *
-     * Starts the job with the values set for the concrete job.
+     * Starts the job with the values set for the concrete job. If starting
+     * the job failed then you are responsible for destroying it. Therefore,
+     * it's recommended to store the job in a std::unique_ptr until it has
+     * been started successfully.
     */
    GpgME::Error startIt();