[Scummvm-cvs-logs] SF.net SVN: scummvm:[50830] scummvm/trunk/common/events.h

[lordhoto at users.sourceforge.net]

Revision: 50830
          http://scummvm.svn.sourceforge.net/scummvm/?rev=50830&view=rev
Author:   lordhoto
Date:     2010-07-12 20:17:42 +0000 (Mon, 12 Jul 2010)

Log Message:
-----------
Some documentation fixes.

Modified Paths:
--------------
    scummvm/trunk/common/events.h

Modified: scummvm/trunk/common/events.h
===================================================================
--- scummvm/trunk/common/events.h	2010-07-12 19:55:42 UTC (rev 50829)
+++ scummvm/trunk/common/events.h	2010-07-12 20:17:42 UTC (rev 50830)
@@ -201,13 +201,14 @@
 	 * 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;
 };


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.