SF.net SVN: fclient: [132] trunk/sandbox/fcp/fcp2_0_uri.py

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

Revision: 132
          http://fclient.svn.sourceforge.net/fclient/?rev=132&view=rev
Author:   jurner
Date:     2008-02-03 19:16:48 -0800 (Sun, 03 Feb 2008)

Log Message:
-----------
docs

Modified Paths:
--------------
    trunk/sandbox/fcp/fcp2_0_uri.py

Modified: trunk/sandbox/fcp/fcp2_0_uri.py
===================================================================
--- trunk/sandbox/fcp/fcp2_0_uri.py	2008-02-04 03:16:21 UTC (rev 131)
+++ trunk/sandbox/fcp/fcp2_0_uri.py	2008-02-04 03:16:48 UTC (rev 132)
@@ -69,18 +69,27 @@
 
 
 class Uri(object):
-		
+	"""Class wrappinf a freenet Uri
+	
+	@ivar keyType: L{consts.KeyType} of the uri
+	@ivar uri: (str) uri contained in the instance
+	"""	
+	
 	KeyType = consts.KeyType
 			
 	
 	def __init__(self, uri):
+		"""
+		@param uri: (str) freenet uri (may be an uri  like http://..CHK@ or 
+		freenet:CHK@ or whatever or a a freenet key)
+		"""
 		self.uri = stripUri(uri)
-		
 		result = keyType(self.uri)
 		self.keyType = self.KeyType.Invalid if result is None else result
 				
 		
 	def __nonzero__(self):
+		"""Checks if the uri contained in the instance is a vaild freenet uri"""
 		return self.keyType != self.KeyType.Invalid
 		
 		


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