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

qt: Fix API documentation

Browse Source 
* lang/qt/src/signkeyjob.h (SignKeyJob::start,
SignKeyJob::setUserIDsToSign, SignKeyJob::setCheckLevel): Fix
documentation of parameters.
--

GnuPG-bug-id: 5245
This commit is contained in:
Ingo Klöcker 2021-04-29 11:58:18 +02:00
parent fde20940b5
commit 0d03f31e07
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lang/qt/src/signkeyjob.h
View File

@ -75,22 +75,19 @@ public:
/** /**
Starts the key signing operation. \a key is the key to sign. Starts the key signing operation. \a key is the key to sign.
@param keyToSign the key to be signed @param keyToSign the key to be signed
@param idsToSign the user IDs to sign
@param signingKey the secret key to use for signing
@param option the signing mode, either local or exportable
*/ */
virtual GpgME::Error start(const GpgME::Key &keyToSign) = 0; virtual GpgME::Error start(const GpgME::Key &keyToSign) = 0;
/** /**
* If explicitly specified, only the listed user IDs will be signed. Otherwise all user IDs * If explicitly specified, only the listed user IDs will be signed. Otherwise all user IDs
* are signed. * are signed.
* @param list of user ID indexes (of the key to be signed). * @param idsToSign list of user ID indexes (of the key to be signed).
*/ */
virtual void setUserIDsToSign(const std::vector<unsigned int> &idsToSign) = 0; virtual void setUserIDsToSign(const std::vector<unsigned int> &idsToSign) = 0;
/** /**
* sets the check level * sets the check level
* @param the check level, ranges from 0 (no claim) and 3 (extensively checked), * @param checkLevel the check level, ranges from 0 (no claim) and 3 (extensively checked),
* default is 0 * default is 0
*/ */
virtual void setCheckLevel(unsigned int checkLevel) = 0; virtual void setCheckLevel(unsigned int checkLevel) = 0;