[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kdecore/jobs
From:       Andreas Pakulat <apaku () gmx ! de>
Date:       2007-11-19 22:56:26
Message-ID: 1195512986.692026.4685.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 738903 by apaku:

Improve api-dox, at least to me it was a surprise that KJob deletes itself just
after emitting its finished signal. Make sure that people are aware of the
fire-and-forget idea behind kjob.


 M  +6 -0      kjob.h  


--- trunk/KDE/kdelibs/kdecore/jobs/kjob.h #738902:738903
@@ -62,6 +62,10 @@
  *  }
  * \endcode
  *
+ * @note: KJob and its subclasses is meant to be used 
+ * in a fire-and-forget way. Its deleting itself when
+ * it has finished using deleteLater() so the job
+ * instance disappears after the next event loop run.
  */
 class KDECORE_EXPORT KJob : public QObject
 {
@@ -493,6 +497,8 @@
      * It first notifies the observers to hide the progress for this job using
      * the finished() signal.
      *
+     * @note: Deletes this job using deleteLater().
+     *
      * @see result()
      * @see finished()
      */
[prev in list] [next in list] [prev in thread] [next in thread]