Removed those extra CVS tag lines in the header files of ghost (now I know what

Gilles meant) and added some extra doxygen tags I had lying around.
Removed the cocoa file since it was rubbish.
Maarten

1 files changed, 13 insertions, 9 deletions

diff --git a/intern/ghost/GHOST_IEventConsumer.h b/intern/ghost/GHOST_IEventConsumer.h
index ddb3de99953..4186d4c1cab 100644
--- a/intern/ghost/GHOST_IEventConsumer.h
+++ b/intern/ghost/GHOST_IEventConsumer.h
@@ -28,13 +28,9 @@
  *
  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  */
-
 /**
-
- * $Id$
- * Copyright (C) 2001 NaN Technologies B.V.
- * @author	Maarten Gribnau
- * @date	May 14, 2001
+ * @file	GHOST_IEventConsumer.h
+ * Declaration of GHOST_IEventConsumer interface class.
  */
 
 #ifndef _GHOST_IEVENT_CONSUMER_H_
@@ -44,6 +40,13 @@
 
 /**
  * Interface class for objects interested in receiving events.
+ * Objects interested in events should inherit this class and implement the
+ * processEvent() method. They should then be registered with the system that
+ * they want to receive events. The system will call the processEvent() method
+ * for every installed event consumer to pass events.
+ * @see GHOST_ISystem#addEventConsumer
+ * @author	Maarten Gribnau
+ * @date	May 14, 2001
  */
 class GHOST_IEventConsumer
 {
@@ -56,9 +59,10 @@ public:
 	}
 
 	/**
-	 * This method is called by an event producer when an event is available.
-	 * @param event	The event that can be handled or ignored.
-	 * @return Indication as to whether the event was handled.
+	 * This method is called by the system when it has events to dispatch.
+	 * @see GHOST_ISystem#dispatchEvents
+	 * @param	event	The event that can be handled or ignored.
+	 * @return	Indication as to whether the event was handled.
 	 */
 	virtual	bool processEvent(GHOST_IEvent* event) = 0;
 };