Doxyfication

qgis · May 11, 2017 · eaabce2 · eaabce2
1 parent 6dc7b57
commit eaabce2
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
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.
      */