From 06dad528cfd813b3e911f45f8b052e28db2a7266 Mon Sep 17 00:00:00 2001 From: Marian Krivos Date: Mon, 22 Aug 2011 17:57:35 +0000 Subject: [PATCH] trunk/branch integration: documentation --- Foundation/include/Poco/Task.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Foundation/include/Poco/Task.h b/Foundation/include/Poco/Task.h index 79b7a78cb..9e0d059f8 100644 --- a/Foundation/include/Poco/Task.h +++ b/Foundation/include/Poco/Task.h @@ -83,10 +83,14 @@ public: /// The value will be between 0.0 (just started) /// and 1.0 (completed). - void cancel(); + virtual void cancel(); /// Requests the task to cancel itself. For cancellation /// to work, the task's runTask() method must periodically /// call isCancelled() and react accordingly. + /// + /// Can be overridden to implement custom behavior, + /// but the base class implementation of cancel() should + /// be called to ensure proper behavior. bool isCancelled() const; /// Returns true if cancellation of the task has been