From 97e09fb96400c50fa207926eb3ea9bd4805406a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ingo=20Kl=C3=B6cker?= Date: Mon, 2 May 2022 14:58:21 +0200 Subject: [PATCH] qt,doc: Fix some API documentation -- Fix or remove API documentation that has been copied and pasted from other jobs. --- lang/qt/src/gpgcardjob.h | 18 ------------------ lang/qt/src/keyformailboxjob.h | 10 +++------- lang/qt/src/keylistjob.h | 2 +- lang/qt/src/refreshkeysjob.h | 2 +- 4 files changed, 5 insertions(+), 27 deletions(-) diff --git a/lang/qt/src/gpgcardjob.h b/lang/qt/src/gpgcardjob.h index 63f5cf7c..3f1b2391 100644 --- a/lang/qt/src/gpgcardjob.h +++ b/lang/qt/src/gpgcardjob.h @@ -44,24 +44,6 @@ class Error; namespace QGpgME { -/** - @short Get the best key to use for a Mailbox - - To use the keyformailboxjob, first obtain an instance from the - CryptoBackend and either exec it or start and - conncet the result() signals to a suitable slot. - The job will be automatically deleted in which - case the KeylistJob instance will have schedules it's own - destruction with a call to QObject::deleteLater(). - - The best key is defined as the key with a UID that has an - E-Mail that matches the mailbox provided. If multiple - keys are found the one with the highest validity is returned. - - After result() is emitted, the - KeyListJob will schedule it's own destruction by calling - QObject::deleteLater(). -*/ class QGPGME_EXPORT GpgCardJob: public Job { Q_OBJECT diff --git a/lang/qt/src/keyformailboxjob.h b/lang/qt/src/keyformailboxjob.h index 42d1729f..5e089074 100644 --- a/lang/qt/src/keyformailboxjob.h +++ b/lang/qt/src/keyformailboxjob.h @@ -57,18 +57,14 @@ namespace QGpgME To use the keyformailboxjob, first obtain an instance from the CryptoBackend and either exec it or start and - conncet the result() signals to a suitable slot. - The job will be automatically deleted in which - case the KeylistJob instance will have schedules it's own - destruction with a call to QObject::deleteLater(). + connect the result() signal to a suitable slot. The best key is defined as the key with a UID that has an E-Mail that matches the mailbox provided. If multiple keys are found the one with the highest validity is returned. - After result() is emitted, the - KeyListJob will schedule it's own destruction by calling - QObject::deleteLater(). + After result() is emitted, the job will schedule it's own + destruction by calling QObject::deleteLater(). */ class QGPGME_EXPORT KeyForMailboxJob: public Job { diff --git a/lang/qt/src/keylistjob.h b/lang/qt/src/keylistjob.h index 88eac871..515a0e4d 100644 --- a/lang/qt/src/keylistjob.h +++ b/lang/qt/src/keylistjob.h @@ -64,7 +64,7 @@ namespace QGpgME CryptoBackend implementation, connect the nextKey(), progress() and result() signals to suitable slots and then start the key listing with a call to start(). This call might fail, in which - case the KeylistJob instance will have schedules it's own + case the KeylistJob instance will have scheduled it's own destruction with a call to QObject::deleteLater(). During keylisting, you will receive new key objects through the diff --git a/lang/qt/src/refreshkeysjob.h b/lang/qt/src/refreshkeysjob.h index cc051fc3..92b3b8f4 100644 --- a/lang/qt/src/refreshkeysjob.h +++ b/lang/qt/src/refreshkeysjob.h @@ -61,7 +61,7 @@ namespace QGpgME RefreshKeysJob instance will have scheduled its own destruction with a call to QObject::deleteLater(). - After result() is emitted, the KeyListJob will schedule it's own + After result() is emitted, the job will schedule it's own destruction by calling QObject::deleteLater(). */ class QGPGME_EXPORT RefreshKeysJob : public Job