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
This commit is contained in:
oepen
2011-09-05 09:31:57 +00:00
parent deebe7d050
commit be4fb180ca
5 changed files with 17 additions and 16 deletions

View File

@@ -126,8 +126,8 @@ def crypto_checksum(algo, key, data, iv=None, ssc=None):
cryptographic checksum as used by the ICAO passports) cryptographic checksum as used by the ICAO passports)
@param key: They key used to computed the cryptographic checksum @param key: They key used to computed the cryptographic checksum
@param data: The data for which to calculate the checksum @param data: The data for which to calculate the checksum
@iv: Optional. An initialization vector. Only used by the \"MAC\" algorithm @param 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 ssc: Optional. A send sequence counter to be prepended to the data. Only
used by the \"CC\" algorithm used by the \"CC\" algorithm
""" """
if algo not in ("HMAC", "MAC", "CC"): if algo not in ("HMAC", "MAC", "CC"):

View File

@@ -36,7 +36,8 @@ class ControlReferenceTemplate:
def __init__(self, tag, config=""): def __init__(self, tag, config=""):
""" """
Generates a new CRT 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 @param config: A string containing TLV encoded Security Environment
parameters parameters
""" """

View File

@@ -17,8 +17,8 @@
# virtualsmartcard. If not, see <http://www.gnu.org/licenses/>. # virtualsmartcard. If not, see <http://www.gnu.org/licenses/>.
# #
""" """
@todo use bertlv_pack for fdm TODO: use bertlv_pack for fdm
@todo zu lange daten abschneiden und trotzdem tlv laenge beibehalten TODO: zu lange daten abschneiden und trotzdem tlv laenge beibehalten
""" """
from pickle import dumps, loads from pickle import dumps, loads
import logging import logging

View File

@@ -123,19 +123,19 @@ class Iso7816OS(SmartcardOS): # {{{
def makeATR(**args): # {{{ def makeATR(**args): # {{{
"""Calculate Answer to Reset (ATR) and returns the bitstring. """Calculate Answer to Reset (ATR) and returns the bitstring.
directConvention -- Bool. Whether to use direct convention or inverse - directConvention (bool): Whether to use direct convention or
convention. inverse convention.
TAi, TBi, TCi -- (optional) Value between 0 and 0xff. Interface - TAi, TBi, TCi (optional): Value between 0 and 0xff. Interface
Characters (for meaning see ISO 7816-3). Note that Characters (for meaning see ISO 7816-3). Note that
if no transmission protocol is given, it is if no transmission protocol is given, it is
automatically selected with T=max{j-1|TAj in args automatically selected with T=max{j-1|TAj in args
OR TBj in args OR TCj in args}. OR TBj in args OR TCj in args}.
T -- (optional) Value between 0 and 15. Transmission - T (optional): Value between 0 and 15. Transmission Protocol.
Protocol. Note that if T is set, TAi/TBi/TCi for Note that if T is set, TAi/TBi/TCi for i>T are
i>T are omitted. omitted.
histChars -- (optional) Bitstring with 0 <= len(histChars) <= 15. - histChars (optional): Bitstring with 0 <= len(histChars) <= 15.
Historical Characters T1 to T15 (for meaning see Historical Characters T1 to T15 (for meaning
ISO 7816-4). see ISO 7816-4).
T0, TDi and TCK are automatically calculated. T0, TDi and TCK are automatically calculated.
""" """

View File

@@ -158,8 +158,8 @@ class APDU(object):
The keyword arguments can then be used to override those values. The keyword arguments can then be used to override those values.
Keywords recognized are: Keywords recognized are:
C_APDU: cla, ins, p1, p2, lc, le, data - C_APDU: cla, ins, p1, p2, lc, le, data
R_APDU: sw, sw1, sw2, data - R_APDU: sw, sw1, sw2, data
""" """
initbuff = list() initbuff = list()