From be4fb180ca77d0fc67705518cc376e22de2fbfdb Mon Sep 17 00:00:00 2001
From: oepen <oepen@96b47cad-a561-4643-ad3b-153ac7d7599c>
Date: Mon, 5 Sep 2011 09:31:57 +0000
Subject: [PATCH] Fixed the documentation. epydoc still fails to build html
 files

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@524 96b47cad-a561-4643-ad3b-153ac7d7599c
---
 .../src/vpicc/virtualsmartcard/CryptoUtils.py  |  4 ++--
 .../src/vpicc/virtualsmartcard/SEutils.py      |  3 ++-
 .../virtualsmartcard/SmartcardFilesystem.py    |  4 ++--
 .../vpicc/virtualsmartcard/VirtualSmartcard.py | 18 +++++++++---------
 .../src/vpicc/virtualsmartcard/utils.py        |  4 ++--
 5 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/virtualsmartcard/src/vpicc/virtualsmartcard/CryptoUtils.py b/virtualsmartcard/src/vpicc/virtualsmartcard/CryptoUtils.py
index f185b31..18b1267 100644
--- a/virtualsmartcard/src/vpicc/virtualsmartcard/CryptoUtils.py
+++ b/virtualsmartcard/src/vpicc/virtualsmartcard/CryptoUtils.py
@@ -126,8 +126,8 @@ def crypto_checksum(algo, key, data, iv=None, ssc=None):
                  cryptographic checksum as used by the ICAO passports)
     @param key:  They key used to computed the cryptographic checksum
     @param data: The data for which to calculate the checksum
-    @iv: Optional. An initialization vector. Only used by the \"MAC\" algorithm
-    @ssc: Optional. A send sequence counter to be prepended to the data. Only
+    @param iv: Optional. An initialization vector. Only used by the \"MAC\" algorithm
+    @param ssc: Optional. A send sequence counter to be prepended to the data. Only
           used by the \"CC\" algorithm
     """
     if algo not in ("HMAC", "MAC", "CC"):
diff --git a/virtualsmartcard/src/vpicc/virtualsmartcard/SEutils.py b/virtualsmartcard/src/vpicc/virtualsmartcard/SEutils.py
index 94f1cb1..cae1105 100644
--- a/virtualsmartcard/src/vpicc/virtualsmartcard/SEutils.py
+++ b/virtualsmartcard/src/vpicc/virtualsmartcard/SEutils.py
@@ -36,7 +36,8 @@ class ControlReferenceTemplate:
     def __init__(self, tag, config=""):
         """
         Generates a new CRT
-        @param type: Type of the CRT (HT, AT, KT, CCT, DST, CT-sym, CT-asym) 
+        @param tag: Indicates the type of the CRT (HT, AT, KT, CCT, DST, CT-sym,
+                    CT-asym) 
         @param config: A string containing TLV encoded Security Environment
                        parameters 
         """
diff --git a/virtualsmartcard/src/vpicc/virtualsmartcard/SmartcardFilesystem.py b/virtualsmartcard/src/vpicc/virtualsmartcard/SmartcardFilesystem.py
index f9bebc0..b1ce8f2 100644
--- a/virtualsmartcard/src/vpicc/virtualsmartcard/SmartcardFilesystem.py
+++ b/virtualsmartcard/src/vpicc/virtualsmartcard/SmartcardFilesystem.py
@@ -17,8 +17,8 @@
 # virtualsmartcard.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-@todo use bertlv_pack for fdm
-@todo zu lange daten abschneiden und trotzdem tlv laenge beibehalten
+TODO: use bertlv_pack for fdm
+TODO: zu lange daten abschneiden und trotzdem tlv laenge beibehalten
 """
 from pickle import dumps, loads
 import logging
diff --git a/virtualsmartcard/src/vpicc/virtualsmartcard/VirtualSmartcard.py b/virtualsmartcard/src/vpicc/virtualsmartcard/VirtualSmartcard.py
index 768649a..0b0cb91 100644
--- a/virtualsmartcard/src/vpicc/virtualsmartcard/VirtualSmartcard.py
+++ b/virtualsmartcard/src/vpicc/virtualsmartcard/VirtualSmartcard.py
@@ -123,19 +123,19 @@ class Iso7816OS(SmartcardOS): # {{{
     def makeATR(**args): # {{{
         """Calculate Answer to Reset (ATR) and returns the bitstring.
         
-        directConvention -- Bool. Whether to use direct convention or inverse 
-                            convention.
-        TAi, TBi, TCi    -- (optional) Value between 0 and 0xff. Interface
+            - directConvention (bool): Whether to use direct convention or 
+                                       inverse convention.
+            - TAi, TBi, TCi (optional): Value between 0 and 0xff. Interface
                             Characters (for meaning see ISO 7816-3). Note that
                             if no transmission protocol is given, it is 
                             automatically selected with T=max{j-1|TAj in args 
                             OR TBj in args OR TCj in args}.
-        T                -- (optional) Value between 0 and 15. Transmission 
-                            Protocol. Note that if T is set, TAi/TBi/TCi for 
-                            i>T are omitted.
-        histChars        -- (optional) Bitstring with 0 <= len(histChars) <= 15.
-                            Historical Characters T1 to T15 (for meaning see
-                            ISO 7816-4).
+            - T (optional): Value between 0 and 15. Transmission Protocol. 
+                            Note that if T is set, TAi/TBi/TCi for i>T are 
+                            omitted.
+            - histChars (optional): Bitstring with 0 <= len(histChars) <= 15.
+                                    Historical Characters T1 to T15 (for meaning 
+                                    see ISO 7816-4).
         
         T0, TDi and TCK are automatically calculated.
         """
diff --git a/virtualsmartcard/src/vpicc/virtualsmartcard/utils.py b/virtualsmartcard/src/vpicc/virtualsmartcard/utils.py
index 39ab179..020974f 100644
--- a/virtualsmartcard/src/vpicc/virtualsmartcard/utils.py
+++ b/virtualsmartcard/src/vpicc/virtualsmartcard/utils.py
@@ -158,8 +158,8 @@ class APDU(object):
         
         The keyword arguments can then be used to override those values.
         Keywords recognized are: 
-            C_APDU: cla, ins, p1, p2, lc, le, data
-            R_APDU: sw, sw1, sw2, data
+            - C_APDU: cla, ins, p1, p2, lc, le, data
+            - R_APDU: sw, sw1, sw2, data
         """
         
         initbuff = list()