Canvas: Support for preventDefault() on Events.

[simgear.git] / simgear / canvas / events / CustomEvent.hxx

diff --git a/simgear/canvas/events/CustomEvent.hxx b/simgear/canvas/events/CustomEvent.hxx
index 1117ba3f1befff3a3c069b6bcbece99b8f3213e0..524f4e67a549207b2bb94250ecbbc244b75d7ae0 100644 (file)
--- a/simgear/canvas/events/CustomEvent.hxx
+++ b/simgear/canvas/events/CustomEvent.hxx
@@ -1,4 +1,5 @@
-///@file Canvas user defined event
+///@file
+/// Canvas user defined event
 //
 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
 //
@@ -27,6 +28,10 @@ namespace simgear
 namespace canvas
 {
 
+  /**
+   * User defined event (optionally carrying additional context information or
+   * data).
+   */
   class CustomEvent:
     public Event
   {