Doxyfication

m-kuhn · m-kuhn · commit eaabce28e96d · 2017-05-11T12:42:26.000+02:00
diff --git a/python/core/qgstaskmanager.sip b/python/core/qgstaskmanager.sip
@@ -174,6 +174,7 @@ class QgsTask : QObject
 %Docstring
  Blocks the current thread until the task finishes or a maximum of ``timeout`` milliseconds.
  If the ``timeout`` is ``-1`` the thread will be blocked forever.
+ In case of a timeout, the task will still be running.
 
  The result will be false if the wait timed out and true in any other case.
  :rtype: bool
diff --git a/src/core/qgstaskmanager.h b/src/core/qgstaskmanager.h
@@ -189,6 +189,7 @@ class CORE_EXPORT QgsTask : public QObject
     /**
      * Blocks the current thread until the task finishes or a maximum of \a timeout milliseconds.
      * If the \a timeout is ``-1`` the thread will be blocked forever.
+     * In case of a timeout, the task will still be running.
      *
      * The result will be false if the wait timed out and true in any other case.
      */

Original file line number	Diff line number	Diff line change
`@@ -189,6 +189,7 @@ class CORE_EXPORT QgsTask : public QObject`
`189`	`189`	`/**`
`190`	`190`	`* Blocks the current thread until the task finishes or a maximum of \a timeout milliseconds.`
`191`	`191`	* If the \a timeout is ``-1`` the thread will be blocked forever.
	`192`	`+ * In case of a timeout, the task will still be running.`
`192`	`193`	`*`
`193`	`194`	`* The result will be false if the wait timed out and true in any other case.`
`194`	`195`	`*/`