SF.net SVN: fclient: [120] trunk/sandbox/fcp/fcp_lib/events.py

[<ju...@us...>]

Revision: 120
          http://fclient.svn.sourceforge.net/fclient/?rev=120&view=rev
Author:   jurner
Date:     2008-02-02 10:29:09 -0800 (Sat, 02 Feb 2008)

Log Message:
-----------
fixed some docstrings for epydoc

Modified Paths:
--------------
    trunk/sandbox/fcp/fcp_lib/events.py

Modified: trunk/sandbox/fcp/fcp_lib/events.py
===================================================================
--- trunk/sandbox/fcp/fcp_lib/events.py	2008-02-02 18:28:43 UTC (rev 119)
+++ trunk/sandbox/fcp/fcp_lib/events.py	2008-02-02 18:29:09 UTC (rev 120)
@@ -10,13 +10,14 @@
 	"""Metaclass for events"""
 	
 	class Event(object):
-		"""Event handler"""
+		"""Event handler
 		
+		@ivar observers: list of observers of the event
+		"""
+		
 		def __init__(self, name):
 			"""
-			@param name: name of the event
-			@attr name: name of the event
-			@attr observers: list of observers of the event
+			@param name: (str) name of the event
 			"""
 			self.name = name
 			self.observers = []
@@ -66,14 +67,7 @@
 	always called with the event as first argument, followed by additional
 	arguments, depending on the event.	
 	
-	Events have the following methods:
-
-		'name': name of the event
-		'observers': list of observers listening to the event
-	
-	
-	Note:
-		Always make shure to disconnnect when event notification is no longer desired
+	@note: always make shure to disconnnect when event notification is no longer desired
 		
 	
 	>>> class MyEvents(Events):


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