Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

Commit ec2a7c71 authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

Summary:
Minor fixes (typos, formatting, missing items).

The list of issues is from EBN:

http://ebn.kde.org/apidocs/apidox-kde-4.x/kdeutils-kgpg.html

Test Plan: Run doxywizard. Ensure that there are no warnings except for mismatched class members.

Reviewers: dakon

Reviewed By: dakon

Subscribers: kde-utils-devel

Differential Revision: https://phabricator.kde.org/D17795
parent dec3ea9c
......@@ -39,7 +39,8 @@ public:
* @brief create a new object to sign and mail key ids
* @param parent parent object
* @param ids list of keys to sign
* @param signids secret key ids to sign @ids with
* @param signids secret key ids to sign @p ids with
* @param checklevel check level, @see carefulCheck
* @param flags control flags
*/
KGpgCaff(QObject *parent, const KGpgSignableNode::List &ids, const QStringList &signids,
......
......@@ -213,6 +213,7 @@ public:
* @param subtype key capabilities of this subkey
* @param keytype key capabilities of this and all subkeys combined
* @param creationDate date of key creation
* @param curve GnuPG ECC curve name
*/
KgpgKeyPrivate(const QString &id, const uint size, const KgpgCore::KgpgKeyTrust trust, const KgpgCore::KgpgKeyAlgo algo,
const KgpgCore::KgpgSubKeyType subtype, const KgpgCore::KgpgSubKeyType keytype, const QDateTime &creationDate,
......@@ -254,6 +255,7 @@ public:
* @param subtype key capabilities of this subkey
* @param keytype key capabilities of this and all subkeys combined
* @param creationDate date of key creation
* @param curve GnuPG ECC curve name
*/
KgpgKey(const QString &id, const uint size, const KgpgCore::KgpgKeyTrust trust, const KgpgCore::KgpgKeyAlgo algo,
const KgpgCore::KgpgSubKeyType subtype, const KgpgCore::KgpgSubKeyType keytype, const QDateTime& creationDate,
......
......@@ -87,10 +87,11 @@ public:
int readln(QStringList &l);
/**
* Recode a line from GnuPG encoding to UTF8
* Recode a line from GnuPG encoding
*
* @param a data to recode
* @param colons recode also colons
* @param codec the name of the new encoding. The default encoding is utf8.
* @return recoded string
*/
static QString recode(QByteArray a, const bool colons = true, const QByteArray &codec = QByteArray());
......
......@@ -315,7 +315,7 @@ private:
* @brief Opens the console when the user want to sign a key manually.
* @param signer key to sign with
* @param keyid key to sign
* @param checking how carefule the identify was checked
* @param checking how careful the identify was checked
* @param local if signature should be local (not exportable)
*/
void signKeyOpenConsole(const QString &signer, const QString &keyid, const int checking, const bool local);
......
......@@ -45,6 +45,7 @@ public:
* @param userIds ids to encrypt to or empty list to use symmetric encryption with passphrase
* @param text text to encrypt
* @param options encryption options
* @param extraOptions extra encryption options
*/
explicit KGpgEncrypt(QObject *parent, const QStringList &userIds = QStringList(), const QString &text = QString(), const EncryptOptions &options = DefaultEncryption, const QStringList &extraOptions = QStringList());
......@@ -54,6 +55,7 @@ public:
* @param userIds ids to encrypt to or empty list to use symmetric encryption with passphrase
* @param files list of file locations to encrypt
* @param options encryption options
* @param extraOptions extra encryption options
*/
KGpgEncrypt(QObject *parent, const QStringList &userIds, const QList<QUrl> &files, const EncryptOptions &options = DefaultEncryption, const QStringList &extraOptions = QStringList());
......
......@@ -103,6 +103,7 @@ public:
/**
* @brief get detailed summary of import
* @param log import log
* @param model item model, @see KGpgItemModel
* @return message describing which keys changed and how
*
* The log must contain a "IMPORT_RES" line. If this is not present
......
......@@ -43,6 +43,7 @@ public:
* @param signId the key to use for signing
* @param text text to sign
* @param options signing options
* @param extraOptions extra signing options
*/
KGpgSignText(QObject *parent, const QString &signId, const QString &text = QString(), const SignOptions &options = AsciiArmored, const QStringList &extraOptions = QStringList());
......@@ -52,6 +53,7 @@ public:
* @param signId the key to use for signing
* @param files list of file locations to sign (must only be 1 file)
* @param options signing options
* @param extraOptions extra signing options
*
* @warning GnuPG can currently handle only one file per invocation for
* signing, so files may only contain one single file.
......
......@@ -43,6 +43,7 @@ protected:
* @brief work with given text
* @param parent parent object
* @param text text to work with
* @param allowChaining whether to allow chaining
*/
explicit KGpgTextOrFileTransaction(QObject *parent = nullptr, const QString &text = QString(), const bool allowChaining = false);
......@@ -50,6 +51,7 @@ protected:
* @brief work with given file(s)
* @param parent parent object
* @param files list of file locations to work with
* @param allowChaining whether to allow chaining
*/
KGpgTextOrFileTransaction(QObject *parent, const QList<QUrl> &files, const bool allowChaining = false);
......
......@@ -36,7 +36,7 @@ class QUrl;
* members to set extra arguments for the process.
*
* If you want to add a new operation create a child class that implements
* nextLine(). Ususally you also need a constructor that takes some information
* nextLine(). Usually you also need a constructor that takes some information
* like the id of the key to modify.
*
* @author Rolf Eike Beer
......@@ -254,9 +254,9 @@ protected:
* @brief called when GnuPG asks for confirmation for overwriting a file
* @param currentFile fill in the current filename for the user dialog
* @return what to answer to GnuPG
* @retval BA_YES file will be overwritten, @currentFile is ignored
* @retval BA_NO file will not be overwritten, if currentFile is given this will automatically be provided as alternative to GnuPG
* @retval BA_UNKNOWN ask the user for a choice or abort, currentFile is provided to the user as a hint about the original filename, if currentFile is empty the transaction is aborted
* @retval BA_YES file will be overwritten, @p currentFile is ignored
* @retval BA_NO file will not be overwritten, if @p currentFile is given this will automatically be provided as alternative to GnuPG
* @retval BA_UNKNOWN ask the user for a choice or abort, @p currentFile is provided to the user as a hint about the original filename, if @p currentFile is empty the transaction is aborted
*
* The default implementation will just return BA_UNKNOWN without setting
* a filename, causing a sequence error.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment