From 191d1492f87aa7f7863d5ee8e2acd0be09fee1af Mon Sep 17 00:00:00 2001 From: dockes Date: Tue, 18 Nov 2008 13:51:09 +0000 Subject: [PATCH] comment --- src/utils/cancelcheck.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/utils/cancelcheck.h b/src/utils/cancelcheck.h index 4ccd1717..6f11c161 100644 --- a/src/utils/cancelcheck.h +++ b/src/utils/cancelcheck.h @@ -16,7 +16,7 @@ */ #ifndef _CANCELCHECK_H_INCLUDED_ #define _CANCELCHECK_H_INCLUDED_ -/* @(#$Id: cancelcheck.h,v 1.4 2008-11-18 13:24:43 dockes Exp $ (C) 2005 J.F.Dockes */ +/* @(#$Id: cancelcheck.h,v 1.5 2008-11-18 13:51:09 dockes Exp $ (C) 2005 J.F.Dockes */ /** @@ -30,10 +30,11 @@ * interaction, if the worker takes too long. * - The worker task calls checkCancel() at regular intervals, possibly as * a side-effect of some other progress-reporting call. If cancellation has - * been requested, this will raise an exception. - * The worker routine must be exception-clean, and the caller should - * catch the CancelExcept exception. - * + * been requested, this will raise an exception, to be catched and processed + * wherever the worker was invoked. + * Of course, the worker side must be exception-clean, but this otherwise avoids + * having to set-up code to handle a special cancellation error along + * the whole worker call stack. */ class CancelExcept {};