SF.net SVN: fclient: [284] trunk/sandbox/fcp2/config.py

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

Revision: 284
          http://fclient.svn.sourceforge.net/fclient/?rev=284&view=rev
Author:   jurner
Date:     2008-02-26 16:13:02 -0800 (Tue, 26 Feb 2008)

Log Message:
-----------
beautifications

Modified Paths:
--------------
    trunk/sandbox/fcp2/config.py

Modified: trunk/sandbox/fcp2/config.py
===================================================================
--- trunk/sandbox/fcp2/config.py	2008-02-26 19:00:14 UTC (rev 283)
+++ trunk/sandbox/fcp2/config.py	2008-02-27 00:13:02 UTC (rev 284)
@@ -70,10 +70,10 @@
 class ConfigItem(object):
 	"""Config item
 	
-	@ivar parent: parent item
-	@ivar name: name of the item
-	@ivar children: (dict) child items
-	@ivar values: dict of values
+	@ivar parent: (ConfigItem) parent item
+	@ivar name: (str) name of the item
+	@ivar children: (dict) child items (itemName --> ConfigItem)
+	@ivar values: (dict) values (L{consts.ConfigValueClass} --> value)
 	"""
 	
 	
@@ -116,9 +116,9 @@
 class Config(object):
 	"""Class representing fcp config tree
 	
-	@ivar parent: parent item
-	@ivar name: name of the config (always None) 
-	@ivar children: (dict) child items
+	@ivar parent: (always None) parent item
+	@ivar name: (always None) name of the config 
+	@ivar children: (dict) child items (itemName --> L{ConfigItem})
 	"""
 			
 	def __init__(self, configDataMsg=None):
@@ -159,7 +159,7 @@
 		@param value to associate
 		@return: (bool) True if the key has been added, False otherwise
 		
-		@note: if the item does not exist, it is created
+		@note: if the item does not already exist it is created
 		@note: if the key is unknown its type will always be set to L{types.FcpType}
 		"""
 		paramClass, components = self._configMessageParams.splitParamClass(key)


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