[Pkg-owncloud-commits] [qtkeychain] 34/63: Add doxygen docs to ReadPasswordJob 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 c9f5bb0cbac3434db360a7076a3b9edf6a34c01f
Author: Elvis Angelaccio <elvis.angelaccio at kdemail.net>
Date:   Wed Aug 17 15:20:32 2016 +0200

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

diff --git a/keychain.h b/keychain.h
index 476f8a2..bf25463 100644
--- a/keychain.h
+++ b/keychain.h
@@ -177,13 +177,35 @@ friend class DeletePasswordJobPrivate;
 
 class ReadPasswordJobPrivate;
 
+/**
+ * @brief Job for reading secrets from the keychain.
+ * You can use a ReadPasswordJob to read passwords or binary data from the keychain.
+ * This job requires a "service" string, which is basically a namespace of keys within the keychain.
+ * This means that you can read all the pairs <key, secret> stored in the same service string.
+ */
 class QKEYCHAIN_EXPORT ReadPasswordJob : public Job {
     Q_OBJECT
 public:
+    /**
+     * Create a new ReadPasswordJob.
+     * @param service The service string used by this job (can be empty).
+     * @param parent The parent of this job.
+     */
     explicit ReadPasswordJob( const QString& service, QObject* parent=0 );
     ~ReadPasswordJob();
 
+    /**
+     * @return The binary data stored as value of this job's key().
+     * @see Job::key()
+     */
     QByteArray binaryData() const;
+
+    /**
+     * @return The string stored as value of this job's key().
+     * @see Job::key()
+     * @warning Returns meaningless data if the data was stored as binary data.
+     * @see WritePasswordJob::setTextData()
+     */
     QString textData() const;
 
 private:

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