summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorAmrykid <amrykid@gmail.com>2011-12-29 08:39:43 -0600
committerAmrykid <amrykid@gmail.com>2011-12-29 08:39:43 -0600
commitf449d2b7611b4d945eabe03ffb52b5235c544d80 (patch)
treeb7451ade5e5f75241a54a3fbe646141bf3551a76 /lib
parentd4566724088eed36d2239e87f6746a5cafb0ad44 (diff)
downloadNim-f449d2b7611b4d945eabe03ffb52b5235c544d80.tar.gz
Fixed the documentation for events.nim.
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/events.nim34
1 files changed, 18 insertions, 16 deletions
diff --git a/lib/pure/events.nim b/lib/pure/events.nim
index 6b8d0c0b1..c3c4cb0dc 100644
--- a/lib/pure/events.nim
+++ b/lib/pure/events.nim
@@ -12,25 +12,27 @@
 ## This module implements an event system that is not dependant on external
 ## graphical toolkits. It was originally called ``NimEE`` because 
 ## it was inspired by Python's PyEE module. There are two ways you can use events: one is a python-inspired way; the other is more of a C-style way.
+##
 ## .. code-block:: Nimrod
-##   var ee = initEventEmitter()
-##   var genericargs: TEventArgs
-##   proc handleevent(e: TEventArgs) =
-##       echo("Handled!")
+##    var ee = initEventEmitter()
+##    var genericargs: TEventArgs
+##    proc handleevent(e: TEventArgs) =
+##        echo("Handled!")
 ##
-##   # Python way
-##   ee.on("EventName", handleevent)
-##   ee.emit("EventName", genericargs)
+##    # Python way
+##    ee.on("EventName", handleevent)
+##    ee.emit("EventName", genericargs)
 ## 
-##   # C/Java way
-##   # Declare a type
-##   type
-##       TSomeObject = object of TObject
-##           SomeEvent: TEventHandler
-##   var myobj: TSomeObject
-##   myobj.SomeEvent = initEventHandler("SomeEvent")
-##   myobj.SomeEvent.addHandler(handleevent)
-##   ee.emit(myobj.SomeEvent, genericargs)
+##    # C/Java way
+##    # Declare a type
+##    type
+##        TSomeObject = object of TObject
+##            SomeEvent: TEventHandler
+##    var myobj: TSomeObject
+##    myobj.SomeEvent = initEventHandler("SomeEvent")
+##    myobj.SomeEvent.addHandler(handleevent)
+##    ee.emit(myobj.SomeEvent, genericargs)
+
 type
   TEventArgs* = object of TObject ## Base object for event arguments that are passed to callback functions.
   TEventHandler* = tuple[name: string, handlers: seq[proc(e:TEventArgs)]] ## An eventhandler for an event.