Commit db1cf0db authored by Rolf Eike Beer's avatar Rolf Eike Beer
Browse files

fix parameter names for documentation

svn path=/trunk/KDE/kdeutils/kgpg/; revision=806221
parent 4a71d32d
......@@ -399,7 +399,7 @@ public slots:
/**
* This slot will generate a new key-pair.
* @param keyname the name of the key, it is also the user's name.
* @param keymail email MUST be a valid email address or an empty string.
* @param keyemail email MUST be a valid email address or an empty string.
* @param keycomment is a comment, it can be an empty string
* @param keyalgo this is the type of the key, RSA or DSA & ELGAMAL (see Kgpg::KeyAlgo).
* @param keysize this is the length of the key (1024, 2048, ...)
......
......@@ -86,7 +86,7 @@ public Q_SLOTS:
/**
* Encrypt text function
* @param text text to be encrypted.
* @param userIDs the recipients key id's.
* @param userids the recipients key id's.
* @param options a list of string with the wanted gpg options. ex: "--armor"
*/
void encryptText(const QString &text, const QStringList &userids, const QStringList &options = QStringList());
......@@ -101,7 +101,7 @@ public Q_SLOTS:
/**
* Sign text function
* @param text QString text to sign.
* @param userIDs the recipient key id's.
* @param userid the recipient key id's.
* @param options StringList with the wanted gpg options.
*/
void signText(const QString &text, const QString &userid, const QStringList &options);
......@@ -114,9 +114,9 @@ public Q_SLOTS:
/**
* Encrypt file function
* @param encryptKeys the recipients key id's.
* @param srcUrl Kurl of the file to encrypt.
* @param destUrl Kurl for the encrypted file.
* @param encryptkeys the recipients key id's.
* @param srcurl Kurl of the file to encrypt.
* @param desturl Kurl for the encrypted file.
* @param options String List with the wanted gpg options. ex: "--armor"
* @param symetrical bool whether the encryption should be symmetrical.
*/
......
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