[Pyscard-devel] SF.net SVN: pyscard:[487] trunk/pyscard/src/smartcard/pcsc

[<lu...@us...>]

Revision: 487
          http://pyscard.svn.sourceforge.net/pyscard/?rev=487&view=rev
Author:   ludov
Date:     2010-06-12 22:14:03 +0000 (Sat, 12 Jun 2010)

Log Message:
-----------
better epydoc

Modified Paths:
--------------
    trunk/pyscard/src/smartcard/pcsc/PCSCCardRequest.py
    trunk/pyscard/src/smartcard/pcsc/PCSCPart10.py

Modified: trunk/pyscard/src/smartcard/pcsc/PCSCCardRequest.py
===================================================================
--- trunk/pyscard/src/smartcard/pcsc/PCSCCardRequest.py	2010-06-12 22:02:30 UTC (rev 486)
+++ trunk/pyscard/src/smartcard/pcsc/PCSCCardRequest.py	2010-06-12 22:14:03 UTC (rev 487)
@@ -45,25 +45,23 @@
     def __init__(self, newcardonly=False, readers=None, cardType=None, cardServiceClass=None, timeout=1):
         """Construct new PCSCCardRequest.
 
-        newcardonly:        if True, request a new card
-                            default is False, i.e. accepts cards already
-                            inserted
+        @param newcardonly: if True, request a new card default is
+        False, i.e. accepts cards already inserted
 
-        readers:            the list of readers to consider for requesting
-                            a card default is to consider all readers
+        @param readers: the list of readers to consider for requesting a
+        card default is to consider all readers
 
-        cardTypeClass:      the CardType class to wait for; default is
-                            AnyCardType, i.e.  the request will returns
-                            with new or already inserted cards
+        @param cardTypeClass: the CardType class to wait for; default is
+        AnyCardType, i.e.  the request will returns with new or already
+        inserted cards
 
-        cardServiceClass:   the specific card service class to create and
-                            bind to the card default is to create and
-                            bind a PassThruCardService
+        @param cardServiceClass: the specific card service class to
+        create and bind to the card default is to create and bind a
+        PassThruCardService
 
-        timeout:            the time in seconds we are ready to wait for
-                            connecting to the requested card.  default
-                            is to wait one second to wait forever, set
-                            timeout to None
+        @param timeout: the time in seconds we are ready to wait for
+        connecting to the requested card.  default is to wait one second
+        to wait forever, set timeout to None
         """
         AbstractCardRequest.__init__(self, newcardonly, readers, cardType, cardServiceClass, timeout)
 

Modified: trunk/pyscard/src/smartcard/pcsc/PCSCPart10.py
===================================================================
--- trunk/pyscard/src/smartcard/pcsc/PCSCPart10.py	2010-06-12 22:02:30 UTC (rev 486)
+++ trunk/pyscard/src/smartcard/pcsc/PCSCPart10.py	2010-06-12 22:14:03 UTC (rev 487)
@@ -101,9 +101,10 @@
 def getFeatureRequest(cardConnection):
     """ Get the list of Part10 features supported by the reader.
 
-    cardConnection: CardConnection object
+    @param cardConnection: L{CardConnection} object
 
-    return: a list of list [[tag1, value1], [tag2, value2]]
+    @rtype: list
+    @return: a list of list [[tag1, value1], [tag2, value2]]
     """
     response = cardConnection.control(CM_IOCTL_GET_FEATURE_REQUEST, [])
     features = []
@@ -121,10 +122,10 @@
 def hasFeature(featureList, feature):
     """ return the controlCode for a feature or None
 
-    feature:     feature to look for
-    featureList: feature list as returned by getFeatureRequest()
+    @param feature:     feature to look for
+    @param featureList: feature list as returned by L{getFeatureRequest()}
 
-    return: feature value or None
+    @return: feature value or None
     """
     for f in featureList:
         if f[0] == feature or Features[f[0]] == feature:
@@ -134,11 +135,12 @@
 def getPinProperties(cardConnection, featureList=None, controlCode=None):
     """ return the PIN_PROPERTIES structure
 
-    cardConnection: CardConnection object
-    featureList: feature list as returned by getFeatureRequest()
-    controlCode: control code for FEATURE_IFD_PIN_PROPERTIES
+    @param cardConnection: L{CardConnection} object
+    @param featureList: feature list as returned by L{getFeatureRequest()}
+    @param controlCode: control code for L{FEATURE_IFD_PIN_PROPERTIES}
 
-    return: a dict """
+    @rtype: dict
+    @return: a dict """
     if controlCode is None:
         if featureList is None:
             featureList = getFeatureRequest(cardConnection)
@@ -161,11 +163,12 @@
 def getTlvProperties(cardConnection, featureList=None, controlCode=None):
     """ return the GET_TLV_PROPERTIES structure
 
-    cardConnection: CardConnection object
-    featureList: feature list as returned by getFeatureRequest()
-    controlCode: control code for FEATURE_GET_TLV_PROPERTIES
+    @param cardConnection: L{CardConnection} object
+    @param featureList: feature list as returned by L{getFeatureRequest()}
+    @param controlCode: control code for L{FEATURE_GET_TLV_PROPERTIES}
 
-    return: a dict """
+    @rtype: dict
+    @return: a dict """
     if controlCode is None:
         if featureList is None:
             featureList = getFeatureRequest(cardConnection)


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