[git] GPGME - branch, master, updated. gpgme-1.7.1-2-g26cbba3

[by Andre Heinecke]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GnuPG Made Easy".

The branch, master has been updated
       via  26cbba3c9cb04a68b95f3a6000ac9bd93fe76dd7 (commit)
      from  cffa9240641e1e176ec96ff4c1b5ab261eb96276 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 26cbba3c9cb04a68b95f3a6000ac9bd93fe76dd7
Author: Andre Heinecke <aheinecke at intevation.de>
Date:   Wed Oct 19 15:17:09 2016 +0200

    qt: Improve WKSPublishJob apidoc
    
    * lang/qt/src/wkspublishjob.h: Improve doc.

diff --git a/lang/qt/src/wkspublishjob.h b/lang/qt/src/wkspublishjob.h
index 0cec630..b17cba4 100644
--- a/lang/qt/src/wkspublishjob.h
+++ b/lang/qt/src/wkspublishjob.h
@@ -47,6 +47,15 @@ namespace QGpgME {
  *
  * Remember that after a result is emitted the job is auto deleted
  * so you can only use it for a single action.
+ *
+ * The workflow is to call startCreate, check for errors and then
+ * send the RFC822 mail returned in returnedData.
+ *
+ * When the response is received start a startRecieve with the
+ * RFC822 mail received as paramater response. Check for errors
+ * and then send again send the result from returnedData back to
+ * the server.
+ *
  */
 class QGPGME_EXPORT WKSPublishJob: public Job
 {
@@ -69,16 +78,16 @@ public:
     virtual void startCheck(const QString &mailbox) = 0;
 
     /** Create a publish request.
-     * The returned Data from the result will contain
-     * the full Mail as returned by gpg-wks-client --create
+     * The returnedData from the result signal will contain
+     * the full Request as returned by gpg-wks-client --create
      *
      * @param fpr the fingerprint of the key to create the request for.
      * @param mailbox A simple mail address without a Name.
      */
     virtual void startCreate(const char *fpr, const QString &mailbox) = 0;
 
-    /** Handle a submisson response. The returned Data will contain
-     * the full Mail as returned by gpg-wks-client --create
+    /** Handle a submisson response. The returnedData in the result singnal
+     * will contain the confirmation response as returned by gpg-wks-client --receive
      *
      * @param response The response of the server.
      **/

-----------------------------------------------------------------------

Summary of changes:
 lang/qt/src/wkspublishjob.h | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)


hooks/post-receive
-- 
GnuPG Made Easy
http://git.gnupg.org