From 93374eaaace42da6c89663f09fcbbf2afcb3637c Mon Sep 17 00:00:00 2001 From: Helmut Grohne Date: Tue, 14 Oct 2008 13:48:02 +0200 Subject: added epydoc markup to doc strings --- wsgitools/digest.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'wsgitools/digest.py') diff --git a/wsgitools/digest.py b/wsgitools/digest.py index 63227be..0aca584 100755 --- a/wsgitools/digest.py +++ b/wsgitools/digest.py @@ -47,7 +47,7 @@ class AuthenticationRequired(Exception): __all__.append("AuthTokenGenerator") class AuthTokenGenerator: - """Generates authentification tokens for AuthDigestMiddleware. The + """Generates authentification tokens for L{AuthDigestMiddleware}. The interface consists of beeing callable with a username and having a realm attribute being a string.""" def __init__(self, realm, getpass): @@ -56,7 +56,8 @@ class AuthTokenGenerator: @param realm: is a string according to RFC2617. @type getpass: str -> str @param getpass: this function is called with a username and password is - expected as result. None may be used as an invalid password.""" + expected as result. C{None} may be used as an invalid password. + """ self.realm = realm self.getpass = getpass def __call__(self, username, algo="md5"): @@ -119,7 +120,7 @@ class StatelessNonceStore(NonceStoreBase): it difficult by posing a timeout on nonces and making it difficult to forge nonces. - This nonce store is usable with scgi.forkpool. + This nonce store is usable with L{scgi.forkpool}. """ def __init__(self, maxage=300, secret=None): """ @@ -298,12 +299,13 @@ class AuthDigestMiddleware: @param app: is the wsgi application to be served with authentification. @type gentoken: str -> str @param gentoken: has to have the same functionality and interface as the - AuthTokenGenerator class. + L{AuthTokenGenerator} class. @type maxage: int - @param maxage: deprecated, see MemoryNonceStore or StatelessNonceStore + @param maxage: deprecated, see L{MemoryNonceStore} or + L{StatelessNonceStore} @type maxuses: int - @param maxuses: deprecated, see MemoryNonceStore - @type store: NonceStoreBase + @param maxuses: deprecated, see L{MemoryNonceStore} + @type store: L{NonceStoreBase} @param store: a nonce storage implementation object. Usage of this parameter will override maxage and maxuses. """ -- cgit v1.2.3