Permalink
Browse files

doco fixes

  • Loading branch information...
1 parent ea13fd9 commit efc5e26851a43ffc74a4edf67bc8a94ae801e119 @rthalley committed Apr 8, 2012
Showing with 38 additions and 21 deletions.
  1. +1 −1 Makefile
  2. +2 −2 dns/e164.py
  3. +2 −2 dns/edns.py
  4. +12 −0 dns/ipv4.py
  5. +18 −12 dns/query.py
  6. +1 −2 dns/resolver.py
  7. +2 −2 dns/tokenizer.py
View
@@ -34,7 +34,7 @@ distclean: clean docclean
rm -f MANIFEST
doc:
- epydoc -n dnspython -u http://www.dnspython.org \
+ epydoc -v -n dnspython -u http://www.dnspython.org \
dns/*.py dns/rdtypes/*.py dns/rdtypes/ANY/*.py \
dns/rdtypes/IN/*.py
View
@@ -32,7 +32,7 @@ def from_e164(text, origin=public_enum_domain):
@type text: str
@param origin: The domain in which the number should be constructed.
The default is e164.arpa.
- @type: dns.name.Name object or None
+ @type origin: dns.name.Name object or None
@rtype: dns.name.Name object
"""
parts = [d for d in text if d.isdigit()]
@@ -45,7 +45,7 @@ def to_e164(name, origin=public_enum_domain, want_plus_prefix=True):
@type name: dns.name.Name object.
@param origin: A domain containing the ENUM domain name. The
name is relativized to this domain before being converted to text.
- @type: dns.name.Name object or None
+ @type origin: dns.name.Name object or None
@param want_plus_prefix: if True, add a '+' to the beginning of the
returned number.
@rtype: str
View
@@ -23,8 +23,8 @@ class Option(object):
def __init__(self, otype):
"""Initialize an option.
- @param rdtype: The rdata type
- @type rdtype: int
+ @param otype: The rdata type
+ @type otype: int
"""
self.otype = otype
View
@@ -20,12 +20,24 @@
import dns.exception
def inet_ntoa(address):
+ """Convert an IPv4 address in network form to text form.
+
+ @param address: The IPv4 address
+ @type address: string
+ @returns: string
+ """
if len(address) != 4:
raise dns.exception.SyntaxError
return '%u.%u.%u.%u' % (ord(address[0]), ord(address[1]),
ord(address[2]), ord(address[3]))
def inet_aton(text):
+ """Convert an IPv4 address in text form to network form.
+
+ @param text: The IPv4 address
+ @type text: string
+ @returns: string
+ """
parts = text.split('.')
if len(parts) != 4:
raise dns.exception.SyntaxError
View
@@ -46,12 +46,15 @@ def _compute_expiration(timeout):
return time.time() + timeout
def _poll_for(fd, readable, writable, error, timeout):
- """
- @param fd: File descriptor (int).
- @param readable: Whether to wait for readability (bool).
- @param writable: Whether to wait for writability (bool).
- @param expiration: Deadline timeout (expiration time, in seconds (float)).
-
+ """Poll polling backend.
+ @param fd: File descriptor
+ @type fd: int
+ @param readable: Whether to wait for readability
+ @type readable: bool
+ @param writable: Whether to wait for writability
+ @type writable: bool
+ @param timeout: Deadline timeout (expiration time, in seconds)
+ @type timeout: float
@return True on success, False on timeout
"""
event_mask = 0
@@ -73,12 +76,15 @@ def _poll_for(fd, readable, writable, error, timeout):
return bool(event_list)
def _select_for(fd, readable, writable, error, timeout):
- """
- @param fd: File descriptor (int).
- @param readable: Whether to wait for readability (bool).
- @param writable: Whether to wait for writability (bool).
- @param expiration: Deadline timeout (expiration time, in seconds (float)).
-
+ """Select polling backend.
+ @param fd: File descriptor
+ @type fd: int
+ @param readable: Whether to wait for readability
+ @type readable: bool
+ @param writable: Whether to wait for writability
+ @type writable: bool
+ @param timeout: Deadline timeout (expiration time, in seconds)
+ @type timeout: float
@return True on success, False on timeout
"""
rset, wset, xset = [], [], []
View
@@ -316,8 +316,7 @@ class LRUCache(object):
def __init__(self, max_size=100000):
"""Initialize a DNS cache.
- @param max_size: The maximum number of nodes to cache; the default is
- 100000. Must be > 1.
+ @param max_size: The maximum number of nodes to cache; the default is 100000. Must be > 1.
@type max_size: int
"""
self.data = {}
View
@@ -62,9 +62,9 @@ def __init__(self, ttype, value='', has_escape=False):
@param ttype: The token type
@type ttype: int
- @ivar value: The token value
+ @param value: The token value
@type value: string
- @ivar has_escape: Does the token value contain escapes?
+ @param has_escape: Does the token value contain escapes?
@type has_escape: bool
"""
self.ttype = ttype

0 comments on commit efc5e26

Please sign in to comment.