checkpoint rdata subclasses doco

1 files changed, 236 insertions, 65 deletions

diff --git a/doc/rdata-subclasses.rst b/doc/rdata-subclasses.rst
index aa9470b..a15f78b 100644
--- a/doc/rdata-subclasses.rst
+++ b/doc/rdata-subclasses.rst
@@ -3,172 +3,343 @@
 Rdata Subclass Reference
 ========================
 
-XXXRTH  This is just a placeholder for proper documentation of all
-the subclasses, which will basically just be documenting the attributes
-of the subclass, as well as any method specific to the subclass.
-
 .. autoclass:: dns.rdata.GenericRdata
-   :members:
 
-.. automodule:: dns.rdtypes.dnskeybase
-   :members:
+   .. attribute:: data
 
-.. automodule:: dns.rdtypes.dsbase
-   :members:
+      A ``bytes`` containing the rdata's value.
 
-.. automodule:: dns.rdtypes.euibase
+.. autoclass:: dns.rdtypes.ANY.AFSDB.AFSDB
    :members:
 
-.. automodule:: dns.rdtypes.mxbase
-   :members:
+   .. attribute:: subtype
 
-.. automodule:: dns.rdtypes.nsbase
-   :members:
+   An ``int``, the AFSDB subtype
 
-.. automodule:: dns.rdtypes.txtbase
-   :members:
+   .. attribute:: hostname
 
-.. automodule:: dns.rdtypes.ANY.AFSDB
-   :members:
+   A ``dns.name.Name``, the AFSDB hostname.
 
-.. automodule:: dns.rdtypes.ANY.AVC
+.. autoclass:: dns.rdtypes.ANY.AVC.AVC
    :members:
 
-.. automodule:: dns.rdtypes.ANY.CAA
+   .. attribute:: strings
+
+   A tuple of ``bytes``, the list of strings.
+
+.. autoclass:: dns.rdtypes.ANY.CAA.CAA
    :members:
 
-.. automodule:: dns.rdtypes.ANY.CDNSKEY
+   .. attribute:: flags
+
+   An ``int``, the flags
+
+   .. attribute:: tag
+                  
+   A ``bytes``, the tag
+
+   .. attribute:: value
+                  
+   A ``bytes``, the value
+
+.. autoclass:: dns.rdtypes.ANY.CDNSKEY.CDNSKEY
    :members:
 
-.. automodule:: dns.rdtypes.ANY.CDS
+   .. attribute:: flags
+
+       An ``int``, the key's flags.
+
+   .. attribute:: protocol
+
+      An ``int``, the protocol for which this key may be used.
+
+   .. attribute:: algorithm:
+
+      An ``int``, the algorithm used for the key.
+
+   .. attribute:: key
+
+      A ``bytes``, the public key.
+
+.. autoclass:: dns.rdtypes.ANY.CDS.CDS
    :members:
 
-.. automodule:: dns.rdtypes.ANY.CERT
+   .. attribute::  key_tag
+
+      An ``int``, the key tag.
+
+   .. attribute:: algorithm
+      
+      An ``int``, the algorithm used for the key.
+
+   .. attribute:: digest_type
+
+      An ``int``, the digest type.
+
+   .. attribute:: digest
+
+      A ``bytes``, the digest of the key.
+
+.. autoclass:: dns.rdtypes.ANY.CERT.CERT
    :members:
 
-.. automodule:: dns.rdtypes.ANY.CNAME
+   .. attribute:: certificate_type
+
+   An ``int``, the certificate type.
+
+   .. attribute:: key_tag
+
+   An ``int``, the key tag.
+
+   .. attribute:: algorithm
+
+   An ``int``, the algorithm.                  
+
+   .. attribute:: certificate
+
+   A ``bytes``, the certificate or CRL.
+
+.. autoclass:: dns.rdtypes.ANY.CNAME.CNAME
    :members:
 
-.. automodule:: dns.rdtypes.ANY.CSYNC
+   .. attribute:: target
+
+   A ``dns.name.Name``, the target name.
+
+.. autoclass:: dns.rdtypes.ANY.CSYNC.CSYNC
    :members:
 
-.. automodule:: dns.rdtypes.ANY.DLV
+    .. attribute:: serial
+
+    An ``int``, the SOA serial number.
+
+    .. attribute:: flags
+
+    An ``int``, the CSYNC flags.
+
+    .. attribute:: windows
+
+    A tuple of ``(int, bytes)`` tuples.
+
+.. autoclass:: dns.rdtypes.ANY.DLV.DLV
    :members:
 
-.. automodule:: dns.rdtypes.ANY.DNAME
+   .. attribute::  key_tag
+
+      An ``int``, the key tag.
+
+   .. attribute:: algorithm
+      
+      An ``int``, the algorithm used for the key.
+
+   .. attribute:: digest_type
+
+      An ``int``, the digest type.
+
+   .. attribute:: digest
+
+      A ``bytes``, the digest of the key.
+
+.. autoclass:: dns.rdtypes.ANY.DNAME.DNAME
    :members:
 
-.. automodule:: dns.rdtypes.ANY.DNSKEY
+   .. attribute:: target
+
+   A ``dns.name.Name``, the target name.
+
+.. autoclass:: dns.rdtypes.ANY.DNSKEY.DNSKEY
    :members:
 
-.. automodule:: dns.rdtypes.ANY.DS
+   .. attribute:: flags
+
+       An ``int``, the key's flags.
+
+   .. attribute:: protocol
+
+      An ``int``, the protocol for which this key may be used.
+
+   .. attribute:: algorithm:
+
+      An ``int``, the algorithm used for the key.
+
+   .. attribute:: key
+
+      A ``bytes``, the public key.
+
+.. autoclass:: dns.rdtypes.ANY.DS.DS
    :members:
 
-.. automodule:: dns.rdtypes.ANY.EUI48
+   .. attribute::  key_tag
+
+      An ``int``, the key tag.
+
+   .. attribute:: algorithm
+      
+      An ``int``, the algorithm used for the key.
+
+   .. attribute:: digest_type
+
+      An ``int``, the digest type.
+
+   .. attribute:: digest
+
+      A ``bytes``, the digest of the key.
+
+.. autoclass:: dns.rdtypes.ANY.EUI48.EUI48
    :members:
 
-.. automodule:: dns.rdtypes.ANY.EUI64
+   .. attribute:: eui
+
+      A ``bytes``, 48-bit Extended Unique Identifier (EUI-48).
+
+.. autoclass:: dns.rdtypes.ANY.EUI64.EUI64
    :members:
 
-.. automodule:: dns.rdtypes.ANY.GPOS
+   .. attribute:: eui
+
+      A ``bytes``, 64-bit Extended Unique Identifier (EUI-64).
+
+.. autoclass:: dns.rdtypes.ANY.GPOS
    :members:
 
-.. automodule:: dns.rdtypes.ANY.HINFO
+.. autoclass:: dns.rdtypes.ANY.HINFO
    :members:
 
-.. automodule:: dns.rdtypes.ANY.HIP
+.. autoclass:: dns.rdtypes.ANY.HIP
    :members:
 
-.. automodule:: dns.rdtypes.ANY.ISDN
+.. autoclass:: dns.rdtypes.ANY.ISDN
    :members:
 
-.. automodule:: dns.rdtypes.ANY.LOC
+.. autoclass:: dns.rdtypes.ANY.LOC
    :members:
 
-.. automodule:: dns.rdtypes.ANY.MX
+.. autoclass:: dns.rdtypes.ANY.MX.MX
    :members:
 
-.. automodule:: dns.rdtypes.ANY.NS
+   .. attribute:: preference
+
+   An ``int``, the preference value
+
+   .. attribute:: exchange
+
+   A ``dns.name.Name``, the exchange name.
+
+.. autoclass:: dns.rdtypes.ANY.NINFO.NINFO
+
+   .. attribute:: strings
+
+   A tuple of ``bytes``, the list of strings.
+
+.. autoclass:: dns.rdtypes.ANY.NS.NS
    :members:
 
-.. automodule:: dns.rdtypes.ANY.NSEC
+   .. attribute:: target
+
+   A ``dns.name.Name``, the target name.
+
+.. autoclass:: dns.rdtypes.ANY.NSEC
    :members:
 
-.. automodule:: dns.rdtypes.ANY.NSEC3
+.. autoclass:: dns.rdtypes.ANY.NSEC3
    :members:
 
-.. automodule:: dns.rdtypes.ANY.NSEC3PARAM
+.. autoclass:: dns.rdtypes.ANY.NSEC3PARAM
    :members:
 
-.. automodule:: dns.rdtypes.ANY.OPENPGPKEY
+.. autoclass:: dns.rdtypes.ANY.OPENPGPKEY
    :members:
 
-.. automodule:: dns.rdtypes.ANY.PTR
+.. autoclass:: dns.rdtypes.ANY.PTR.PTR
    :members:
 
-.. automodule:: dns.rdtypes.ANY.RP
+   .. attribute:: target
+
+   A ``dns.name.Name``, the target name.
+
+.. autoclass:: dns.rdtypes.ANY.RP
    :members:
 
-.. automodule:: dns.rdtypes.ANY.RRSIG
+.. autoclass:: dns.rdtypes.ANY.RRSIG
    :members:
 
-.. automodule:: dns.rdtypes.ANY.RT
+.. autoclass:: dns.rdtypes.ANY.RT.RT
    :members:
 
-.. automodule:: dns.rdtypes.ANY.SOA
+   .. attribute:: preference
+
+   An ``int``, the preference value
+
+   .. attribute:: exchange
+
+   A ``dns.name.Name``, the exchange name.
+      
+.. autoclass:: dns.rdtypes.ANY.SOA
    :members:
 
-.. automodule:: dns.rdtypes.ANY.SPF
+.. autoclass:: dns.rdtypes.ANY.SPF.SPF
    :members:
 
-.. automodule:: dns.rdtypes.ANY.SSHFP
+   .. attribute:: strings
+
+   A tuple of ``bytes``, the list of strings.
+
+.. autoclass:: dns.rdtypes.ANY.SSHFP
    :members:
 
-.. automodule:: dns.rdtypes.ANY.TLSA
+.. autoclass:: dns.rdtypes.ANY.TLSA
    :members:
 
-.. automodule:: dns.rdtypes.ANY.TXT
+.. autoclass:: dns.rdtypes.ANY.TXT.TXT
    :members:
 
-.. automodule:: dns.rdtypes.ANY.URI
+   .. attribute:: strings
+
+   A tuple of ``bytes``, the list of strings.
+
+.. autoclass:: dns.rdtypes.ANY.URI
    :members:
 
-.. automodule:: dns.rdtypes.ANY.X25
+.. autoclass:: dns.rdtypes.ANY.X25
    :members:
 
-.. automodule:: dns.rdtypes.IN.A
+.. autoclass:: dns.rdtypes.IN.A
    :members:
 
-.. automodule:: dns.rdtypes.IN.AAAA
+.. autoclass:: dns.rdtypes.IN.AAAA
    :members:
 
-.. automodule:: dns.rdtypes.IN.APL
+.. autoclass:: dns.rdtypes.IN.APL
    :members:
 
-.. automodule:: dns.rdtypes.IN.DHCID
+.. autoclass:: dns.rdtypes.IN.DHCID
    :members:
 
-.. automodule:: dns.rdtypes.IN.IPSECKEY
+.. autoclass:: dns.rdtypes.IN.IPSECKEY
    :members:
 
-.. automodule:: dns.rdtypes.IN.KX
+.. autoclass:: dns.rdtypes.IN.KX
    :members:
 
-.. automodule:: dns.rdtypes.IN.NAPTR
+.. autoclass:: dns.rdtypes.IN.NAPTR
    :members:
 
-.. automodule:: dns.rdtypes.IN.NSAP
+.. autoclass:: dns.rdtypes.IN.NSAP
    :members:
 
-.. automodule:: dns.rdtypes.IN.NSAP_PTR
+.. autoclass:: dns.rdtypes.IN.NSAP_PTR.NSAP_PTR
    :members:
 
-.. automodule:: dns.rdtypes.IN.PX
+   .. attribute:: target
+
+   A ``dns.name.Name``, the target name.
+
+.. autoclass:: dns.rdtypes.IN.PX
    :members:
 
-.. automodule:: dns.rdtypes.IN.SRV
+.. autoclass:: dns.rdtypes.IN.SRV
    :members:
 
-.. automodule:: dns.rdtypes.IN.WKS
+.. autoclass:: dns.rdtypes.IN.WKS
    :members: