[Pkg-owncloud-commits] [qtkeychain] 36/63: Don't suggest to use local event loops

[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 3cfac5fbb52f0b7c2d4ffbc8ba82f9f1d83a9a8d
Author: Elvis Angelaccio <elvis.angelaccio at kdemail.net>
Date:   Wed Aug 17 15:49:40 2016 +0200

    Don't suggest to use local event loops
    
    and fix typos.
---
 keychain.h | 28 +++-------------------------
 1 file changed, 3 insertions(+), 25 deletions(-)

diff --git a/keychain.h b/keychain.h
index ac27926..2d90fc6 100644
--- a/keychain.h
+++ b/keychain.h
@@ -50,29 +50,7 @@ public:
 
     /**
      * Call this method to start the job.
-     * Tipically you want to connect some slot to the finished() signal first.
-     * You can run the job either synchronously or asynchronously.
-     *
-     * In the first case you tipically use an inner event loop:
-     *
-     * \code
-     * SomeClass::startJob()
-     * {
-     *     QEventLoop eventLoop;
-     *     connect(job, &Job::finished, &eventLoop, &QEventLoop::quit);
-     *     job->start();
-     *     eventLoop.exec();
-     *
-     *     if (job->error() {
-     *         // handle error
-     *     } else {
-     *         // do job-specific stuff
-     *     }
-     * }
-     * \endcode
-     *
-     * In the asynchronous case you just connect some slot to the finished() signal
-     * and you will handle the job's completion there:
+     * Typically you want to connect some slot to the finished() signal first:
      *
      * \code
      * SomeClass::startJob()
@@ -83,7 +61,7 @@ public:
      *
      * SomeClass::slotJobFinished(Job *job)
      * {
-     *     if (job->error() {
+     *     if (job->error()) {
      *         // handle error
      *     } else {
      *         // do job-specific stuff
@@ -239,7 +217,7 @@ public:
 
     /**
      * Set the @p data that the job will store in the keychain as string.
-     * Tipically @p data is a password.
+     * Typically @p data is a password.
      * @warning setBinaryData() and setTextData() are mutually exclusive.
      */
     void setTextData( const QString& data );

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