[Pkg-owncloud-commits] [qtkeychain] 33/63: Add doxygen docs to WritePasswordJob class

[Sandro Knauß]

This is an automated email from the git hooks/post-receive script.

hefee pushed a commit to branch master
in repository qtkeychain.

commit 5331b6ef376c3318afc4309f5af10d75061c6eb5
Author: Elvis Angelaccio <elvis.angelaccio at kdemail.net>
Date:   Wed Aug 17 15:07:08 2016 +0200

    Add doxygen docs to WritePasswordJob class
---
 keychain.h | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/keychain.h b/keychain.h
index 5d09750..476f8a2 100644
--- a/keychain.h
+++ b/keychain.h
@@ -192,13 +192,34 @@ private:
 
 class WritePasswordJobPrivate;
 
+/**
+ * @brief Job for writing secrets to the keychain.
+ * You can use a WritePasswordJob to store passwords or binary data in the keychain.
+ * This job requires a "service" string, which is basically a namespace of keys within the keychain.
+ * This means that you can store different pairs <key, secret> under the same service string.
+ */
 class QKEYCHAIN_EXPORT WritePasswordJob : public Job {
     Q_OBJECT
 public:
+    /**
+     * Create a new WritePasswordJob.
+     * @param service The service string used by this job (can be empty).
+     * @param parent The parent of this job.
+     */
     explicit WritePasswordJob( const QString& service, QObject* parent=0 );
     ~WritePasswordJob();
 
+    /**
+     * Set the @p data that the job will store in the keychain as binary data.
+     * @warning setBinaryData() and setTextData() are mutually exclusive.
+     */
     void setBinaryData( const QByteArray& data );
+
+    /**
+     * Set the @p data that the job will store in the keychain as string.
+     * Tipically @p data is a password.
+     * @warning setBinaryData() and setTextData() are mutually exclusive.
+     */
     void setTextData( const QString& data );
 
 private:

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/qtkeychain.git