Skip to content

Commit

Permalink
Doxyfication
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed May 11, 2017
1 parent 6dc7b57 commit eaabce2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions python/core/qgstaskmanager.sip
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions src/core/qgstaskmanager.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down

0 comments on commit eaabce2

Please sign in to comment.