GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qt,doc: Fix some API documentation

Browse Source 
--

Fix or remove API documentation that has been copied and pasted from
other jobs.
This commit is contained in:
Ingo Klöcker 2022-05-02 14:58:21 +02:00
parent 54c4fd16d1
commit 97e09fb964
4 changed files with 5 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lang/qt/src/gpgcardjob.h
View File

@ -44,24 +44,6 @@ class Error;
namespace QGpgME 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 class QGPGME_EXPORT GpgCardJob: public Job
{ {
Q_OBJECT Q_OBJECT

10
lang/qt/src/keyformailboxjob.h
View File

@ -57,18 +57,14 @@ namespace QGpgME
To use the keyformailboxjob, first obtain an instance from the To use the keyformailboxjob, first obtain an instance from the
CryptoBackend and either exec it or start and CryptoBackend and either exec it or start and
conncet the result() signals to a suitable slot. connect the result() signal 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 The best key is defined as the key with a UID that has an
E-Mail that matches the mailbox provided. If multiple E-Mail that matches the mailbox provided. If multiple
keys are found the one with the highest validity is returned. keys are found the one with the highest validity is returned.
After result() is emitted, the After result() is emitted, the job will schedule it's own
KeyListJob will schedule it's own destruction by calling destruction by calling QObject::deleteLater().
QObject::deleteLater().
*/ */
class QGPGME_EXPORT KeyForMailboxJob: public Job class QGPGME_EXPORT KeyForMailboxJob: public Job
{ {

2
lang/qt/src/keylistjob.h
View File

@ -64,7 +64,7 @@ namespace QGpgME
CryptoBackend implementation, connect the nextKey(), progress() CryptoBackend implementation, connect the nextKey(), progress()
and result() signals to suitable slots and then start the key and result() signals to suitable slots and then start the key
listing with a call to start(). This call might fail, in which 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(). destruction with a call to QObject::deleteLater().
During keylisting, you will receive new key objects through the During keylisting, you will receive new key objects through the

2
lang/qt/src/refreshkeysjob.h
View File

@ -61,7 +61,7 @@ namespace QGpgME
RefreshKeysJob instance will have scheduled its own destruction RefreshKeysJob instance will have scheduled its own destruction
with a call to QObject::deleteLater(). 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(). destruction by calling QObject::deleteLater().
*/ */
class QGPGME_EXPORT RefreshKeysJob : public Job class QGPGME_EXPORT RefreshKeysJob : public Job