From: Bob Halley <halley@dnspython.org>
Date: Sat, 9 May 2020 22:15:07 +0000 (-0700)
Subject: checkpoint more rdata subclasses doco
X-Git-Tag: v2.0.0rc1~240
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4b40c4214c2aeedccb73486345cb541f827dc124;p=thirdparty%2Fdnspython.git

checkpoint more rdata subclasses doco
---

diff --git a/dns/rdtypes/ANY/GPOS.py b/dns/rdtypes/ANY/GPOS.py
index 07be5d66..d28ef303 100644
--- a/dns/rdtypes/ANY/GPOS.py
+++ b/dns/rdtypes/ANY/GPOS.py
@@ -44,15 +44,9 @@ def _sanitize(value):
 
 class GPOS(dns.rdata.Rdata):
 
-    """GPOS record
-
-    @ivar latitude: latitude
-    @type latitude: string
-    @ivar longitude: longitude
-    @type longitude: string
-    @ivar altitude: altitude
-    @type altitude: string
-    @see: RFC 1712"""
+    """GPOS record"""
+
+    # see: RFC 1712
 
     __slots__ = ['latitude', 'longitude', 'altitude']
 
diff --git a/dns/rdtypes/ANY/HINFO.py b/dns/rdtypes/ANY/HINFO.py
index 85eef580..5bc6a156 100644
--- a/dns/rdtypes/ANY/HINFO.py
+++ b/dns/rdtypes/ANY/HINFO.py
@@ -24,13 +24,9 @@ import dns.tokenizer
 
 class HINFO(dns.rdata.Rdata):
 
-    """HINFO record
+    """HINFO record"""
 
-    @ivar cpu: the CPU type
-    @type cpu: string
-    @ivar os: the OS type
-    @type os: string
-    @see: RFC 1035"""
+    # see: RFC 1035
 
     __slots__ = ['cpu', 'os']
 
diff --git a/dns/rdtypes/ANY/HIP.py b/dns/rdtypes/ANY/HIP.py
index 2efc23bd..8ac1d177 100644
--- a/dns/rdtypes/ANY/HIP.py
+++ b/dns/rdtypes/ANY/HIP.py
@@ -26,17 +26,9 @@ import dns.rdatatype
 
 class HIP(dns.rdata.Rdata):
 
-    """HIP record
+    """HIP record"""
 
-    @ivar hit: the host identity tag
-    @type hit: string
-    @ivar algorithm: the public key cryptographic algorithm
-    @type algorithm: int
-    @ivar key: the public key
-    @type key: string
-    @ivar servers: the rendezvous servers
-    @type servers: list of dns.name.Name objects
-    @see: RFC 5205"""
+    # see: RFC 5205
 
     __slots__ = ['hit', 'algorithm', 'key', 'servers']
 
diff --git a/dns/rdtypes/ANY/ISDN.py b/dns/rdtypes/ANY/ISDN.py
index 467eeed5..e49dac66 100644
--- a/dns/rdtypes/ANY/ISDN.py
+++ b/dns/rdtypes/ANY/ISDN.py
@@ -24,13 +24,9 @@ import dns.tokenizer
 
 class ISDN(dns.rdata.Rdata):
 
-    """ISDN record
+    """ISDN record"""
 
-    @ivar address: the ISDN address
-    @type address: string
-    @ivar subaddress: the ISDN subaddress (or '' if not present)
-    @type subaddress: string
-    @see: RFC 1183"""
+    # see: RFC 1183
 
     __slots__ = ['address', 'subaddress']
 
diff --git a/dns/rdtypes/ANY/LOC.py b/dns/rdtypes/ANY/LOC.py
index b926fda0..dc768de1 100644
--- a/dns/rdtypes/ANY/LOC.py
+++ b/dns/rdtypes/ANY/LOC.py
@@ -90,23 +90,9 @@ def _decode_size(what, desc):
 
 class LOC(dns.rdata.Rdata):
 
-    """LOC record
-
-    @ivar latitude: latitude
-    @type latitude: (int, int, int, int, sign) tuple specifying the degrees, minutes,
-    seconds, milliseconds, and sign of the coordinate.
-    @ivar longitude: longitude
-    @type longitude: (int, int, int, int, sign) tuple specifying the degrees,
-    minutes, seconds, milliseconds, and sign of the coordinate.
-    @ivar altitude: altitude
-    @type altitude: float
-    @ivar size: size of the sphere
-    @type size: float
-    @ivar horizontal_precision: horizontal precision
-    @type horizontal_precision: float
-    @ivar vertical_precision: vertical precision
-    @type vertical_precision: float
-    @see: RFC 1876"""
+    """LOC record"""
+
+    # see: RFC 1876
 
     __slots__ = ['latitude', 'longitude', 'altitude', 'size',
                  'horizontal_precision', 'vertical_precision']
diff --git a/doc/rdata-subclasses.rst b/doc/rdata-subclasses.rst
index a15f78ba..8929425f 100644
--- a/doc/rdata-subclasses.rst
+++ b/doc/rdata-subclasses.rst
@@ -199,21 +199,91 @@ Rdata Subclass Reference
 
       A ``bytes``, 64-bit Extended Unique Identifier (EUI-64).
 
-.. autoclass:: dns.rdtypes.ANY.GPOS
+.. autoclass:: dns.rdtypes.ANY.GPOS.GPOS
    :members:
 
-.. autoclass:: dns.rdtypes.ANY.HINFO
+   .. attribute:: latitude
+
+   A ``bytes``, the latitude
+
+   .. attribute:: longitude
+
+   A ``bytes``, the longitude
+
+   .. attribute:: altitude
+
+   A ``bytes``, the altitude
+
+.. autoclass:: dns.rdtypes.ANY.HINFO.HINFO
    :members:
 
-.. autoclass:: dns.rdtypes.ANY.HIP
+   .. attribute:: cpu
+
+   A ``bytes``, the CPU type.
+
+   .. attribute:: os
+
+   A ``bytes``, the OS type.
+
+.. autoclass:: dns.rdtypes.ANY.HIP.HIP
    :members:
 
-.. autoclass:: dns.rdtypes.ANY.ISDN
+   .. attribute:: hit
+
+   A ``bytes``, the host identity tag.
+
+   .. attribute:: algorithm
+
+   An ``int``, the public key cryptographic algorithm.
+
+   .. attribute:: key
+
+   A ``bytes``, the public key.
+
+   .. attribute:: servers
+
+   A tuple of ``dns.name.Name`` objects, the rendezvous servers.
+
+.. autoclass:: dns.rdtypes.ANY.ISDN.ISDN
    :members:
+      
+   .. attribute:: address
+
+   A ``bytes``, the ISDN address.
+
+   .. attribute:: subaddress
 
-.. autoclass:: dns.rdtypes.ANY.LOC
+   A ``bytes`` the ISDN subaddress (or ``b''`` if not present).
+
+.. autoclass:: dns.rdtypes.ANY.LOC.LOC
    :members:
 
+   .. attribute:: latitude
+
+   An ``(int, int, int, int, int)`` tuple specifying the degrees, minutes,
+   seconds, milliseconds, and sign of the latitude.
+
+   .. attribute:: longitude
+
+   An ``(int, int, int, int, int)`` tuple specifying the degrees, minutes,
+   seconds, milliseconds, and sign of the longitude.
+
+   .. attribute:: altitude
+
+   A ``float``, the altitude, in centimeters.
+
+   .. attribute:: size
+
+   A ``float``, the size of the sphere, in centimeters.
+
+   .. attribute:: horizontal_precision
+
+   A ``float``, the horizontal precision, in centimeters.
+
+   .. attribute:: vertical_precision
+
+   A ``float``, the vertical precision, in centimeters.
+
 .. autoclass:: dns.rdtypes.ANY.MX.MX
    :members: