From 8d7bc0eab5b8987829fb78690f0034283e98b549 Mon Sep 17 00:00:00 2001 From: Johannes Schickel Date: Mon, 12 Jul 2010 20:17:42 +0000 Subject: Some documentation fixes. svn-id: r50830 --- common/events.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'common') diff --git a/common/events.h b/common/events.h index 24c9a23728..3c4f6e8d1c 100644 --- a/common/events.h +++ b/common/events.h @@ -201,13 +201,14 @@ public: * Notifies the observer of an incoming event. * * An observer is supposed to eat the event, with returning true, when - * it might want prevent other observers from preventing to receive - * the event. An usage example here is the keymapper: + * it wants to prevent other observers from receiving the event. + * An usage example here is the keymapper: * If it processes an Event, it should 'eat' it and create a new * event, which the EventDispatcher will then catch. * - * @param event the event, which is incoming. - * @return true if this observer uses this event, false otherwise. + * @param event the event, which is incoming. + * @return true if the event should not be passed to other observers, + * false otherwise. */ virtual bool notifyEvent(const Event &event) = 0; }; -- cgit v1.2.3