From 6a8b57d40a1e790052d2af85032de3e287364240 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Gr=C3=A4=C3=9Flin?= Date: Sun, 13 Mar 2011 17:03:00 +0100 Subject: [PATCH] Adjust documentation for Effect after removing the virtuals --- libkwineffects/kwineffects.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/libkwineffects/kwineffects.h b/libkwineffects/kwineffects.h index badba1093d..d5f1813fea 100644 --- a/libkwineffects/kwineffects.h +++ b/libkwineffects/kwineffects.h @@ -219,9 +219,11 @@ QRect infiniteRegion() * This is the base class for all effects. By reimplementing virtual methods * of this class, you can customize how the windows are painted. * - * The virtual methods of this class can broadly be divided into two - * categories: the methods used for painting and those you can use to be - * notified and react to certain events, e.g. that a window was closed. + * The virtual methods are used for painting and need to be implemented for + * custom painting. + * + * In order to react to state changes (e.g. a window gets closed) the effect + * should provide slots for the signals emitted by the EffectsHandler. * * @section Chaining * Most methods of this class are called in chain style. This means that when