[Pkg-owncloud-commits] [qtkeychain] 35/63: Add doxygen docs to DeletePasswordJob 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 d5d7639e05dfb6f097cfedcafadd57ae28e46cf4
Author: Elvis Angelaccio <elvis.angelaccio at kdemail.net>
Date:   Wed Aug 17 15:23:47 2016 +0200

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

diff --git a/keychain.h b/keychain.h
index bf25463..ac27926 100644
--- a/keychain.h
+++ b/keychain.h
@@ -251,9 +251,20 @@ private:
 
 class DeletePasswordJobPrivate;
 
+/**
+ * @brief Job for deleting secrets from the keychain.
+ * You can use a DeletePasswordJob to delete 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 delete all the pairs <key, secret> stored in the same service string.
+ */
 class QKEYCHAIN_EXPORT DeletePasswordJob : public Job {
     Q_OBJECT
 public:
+    /**
+     * Create a new DeletePasswordJob.
+     * @param service The service string used by this job (can be empty).
+     * @param parent The parent of this job.
+     */
     explicit DeletePasswordJob( const QString& service, QObject* parent=0 );
     ~DeletePasswordJob();
 

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