@@ -20,56 +20,56 @@ #import "socket.h" OF_ASSUME_NONNULL_BEGIN -/*! @file */ +/** @file */ @class OFArray OF_GENERIC(ObjectType); @class OFData; -/*! +/** * @brief The DNS class. */ typedef enum { - /*! IN */ + /** IN */ OF_DNS_CLASS_IN = 1, - /*! Any class. Only for queries. */ + /** Any class. Only for queries. */ OF_DNS_CLASS_ANY = 255, } of_dns_class_t; -/*! +/** * @brief The type of a DNS resource record. */ typedef enum { - /*! A */ + /** A */ OF_DNS_RECORD_TYPE_A = 1, - /*! NS */ + /** NS */ OF_DNS_RECORD_TYPE_NS = 2, - /*! CNAME */ + /** CNAME */ OF_DNS_RECORD_TYPE_CNAME = 5, - /*! SOA */ + /** SOA */ OF_DNS_RECORD_TYPE_SOA = 6, - /*! PTR */ + /** PTR */ OF_DNS_RECORD_TYPE_PTR = 12, - /*! HINFO */ + /** HINFO */ OF_DNS_RECORD_TYPE_HINFO = 13, - /*! MX */ + /** MX */ OF_DNS_RECORD_TYPE_MX = 15, - /*! TXT */ + /** TXT */ OF_DNS_RECORD_TYPE_TXT = 16, - /*! RP */ + /** RP */ OF_DNS_RECORD_TYPE_RP = 17, - /*! AAAA */ + /** AAAA */ OF_DNS_RECORD_TYPE_AAAA = 28, - /*! SRV */ + /** SRV */ OF_DNS_RECORD_TYPE_SRV = 33, - /*! All types. Only for queries. */ + /** All types. Only for queries. */ OF_DNS_RECORD_TYPE_ALL = 255, } of_dns_record_type_t; -/*! +/** * @class OFDNSResourceRecord OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing a DNS resource record. */ @interface OFDNSResourceRecord: OFObject @@ -84,27 +84,27 @@ /** * @brief The domain name to which the resource record belongs. */ @property (readonly, nonatomic) OFString *name; -/*! +/** * @brief The DNS class. */ @property (readonly, nonatomic) of_dns_class_t DNSClass; -/*! +/** * @brief The resource record type code. */ @property (readonly, nonatomic) of_dns_record_type_t recordType; -/*! +/** * @brief The number of seconds after which the resource record should be * discarded from the cache. */ @property (readonly, nonatomic) uint32_t TTL; -/*! +/** * @brief Initializes an already allocated OFDNSResourceRecord with the * specified name, class, type, data and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -116,11 +116,11 @@ DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFADNSResourceRecord OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an A DNS resource record. */ OF_SUBCLASSING_RESTRICTED @@ -127,21 +127,21 @@ @interface OFADNSResourceRecord: OFDNSResourceRecord { of_socket_address_t _address; } -/*! +/** * @brief The IPv4 address of the resource record. */ @property (readonly, nonatomic) const of_socket_address_t *address; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFADNSResourceRecord with the * specified name, class, address and time to live. * * @param name The name for the resource record * @param address The address for the resource record @@ -151,11 +151,11 @@ - (instancetype)initWithName: (OFString *)name address: (const of_socket_address_t *)address TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFAAAADNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class represenging a DNS resource record. */ @@ -163,21 +163,21 @@ @interface OFAAAADNSResourceRecord: OFDNSResourceRecord { of_socket_address_t _address; } -/*! +/** * @brief The IPv6 address of the resource record. */ @property (readonly, nonatomic) const of_socket_address_t *address; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFAAAADNSResourceRecord with the * specified name, class, address and time to live. * * @param name The name for the resource record * @param address The address for the resource record @@ -187,11 +187,11 @@ - (instancetype)initWithName: (OFString *)name address: (const of_socket_address_t *)address TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFCNAMEDNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing a CNAME DNS resource record. */ @@ -199,21 +199,21 @@ @interface OFCNAMEDNSResourceRecord: OFDNSResourceRecord { OFString *_alias; } -/*! +/** * @brief The alias of the resource record. */ @property (readonly, nonatomic) OFString *alias; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFCNAMEDNSResourceRecord with the * specified name, class, alias and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -225,11 +225,11 @@ DNSClass: (of_dns_class_t)DNSClass alias: (OFString *)alias TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFHINFODNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an HINFO DNS resource record. */ @@ -237,26 +237,26 @@ @interface OFHINFODNSResourceRecord: OFDNSResourceRecord { OFString *_CPU, *_OS; } -/*! +/** * @brief The CPU of the host info of the resource record. */ @property (readonly, nonatomic) OFString *CPU; -/*! +/** * @brief The OS of the host info of the resource record. */ @property (readonly, nonatomic) OFString *OS; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFHINFODNSResourceRecord with the * specified name, class, domain name and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -270,11 +270,11 @@ CPU: (OFString *)CPU OS: (OFString *)OS TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFMXDNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an MX DNS resource record. */ @@ -283,26 +283,26 @@ { uint16_t _preference; OFString *_mailExchange; } -/*! +/** * @brief The preference of the resource record. */ @property (readonly, nonatomic) uint16_t preference; -/*! +/** * @brief The mail exchange of the resource record. */ @property (readonly, nonatomic) OFString *mailExchange; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFMXDNSResourceRecord with the * specified name, class, preference, mail exchange and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -316,11 +316,11 @@ preference: (uint16_t)preference mailExchange: (OFString *)mailExchange TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFNSDNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an NS DNS resource record. */ @@ -328,21 +328,21 @@ @interface OFNSDNSResourceRecord: OFDNSResourceRecord { OFString *_authoritativeHost; } -/*! +/** * @brief The authoritative host of the resource record. */ @property (readonly, nonatomic) OFString *authoritativeHost; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFNSDNSResourceRecord with the * specified name, class, authoritative host and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -354,11 +354,11 @@ DNSClass: (of_dns_class_t)DNSClass authoritativeHost: (OFString *)authoritativeHost TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFPTRDNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing a PTR DNS resource record. */ @@ -366,21 +366,21 @@ @interface OFPTRDNSResourceRecord: OFDNSResourceRecord { OFString *_domainName; } -/*! +/** * @brief The domain name of the resource record. */ @property (readonly, nonatomic) OFString *domainName; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFPTRDNSResourceRecord with the * specified name, class, domain name and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -392,11 +392,11 @@ DNSClass: (of_dns_class_t)DNSClass domainName: (OFString *)domainName TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFRPNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an RP DNS resource record. */ @@ -404,16 +404,16 @@ @interface OFRPDNSResourceRecord: OFDNSResourceRecord { OFString *_mailbox, *_TXTDomainName; } -/*! +/** * @brief The mailbox of the responsible person of the resource record. */ @property (readonly, nonatomic) OFString *mailbox; -/*! +/** * @brief A domain name that contains a TXT resource record for the responsible * person of the resource record. */ @property (readonly, nonatomic) OFString *TXTDomainName; @@ -420,11 +420,11 @@ - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFRPDNSResourceRecord with the * specified name, class, alias and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -439,11 +439,11 @@ mailbox: (OFString *)mailbox TXTDomainName: (OFString *)TXTDomainName TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFSOADNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an SOA DNS resource record. */ @@ -453,51 +453,51 @@ OFString *_primaryNameServer, *_responsiblePerson; uint32_t _serialNumber, _refreshInterval, _retryInterval; uint32_t _expirationInterval, _minTTL; } -/*! +/** * @brief The the primary name server for the zone. */ @property (readonly, nonatomic) OFString *primaryNameServer; -/*! +/** * @brief The mailbox of the person responsible for the zone. */ @property (readonly, nonatomic) OFString *responsiblePerson; -/*! +/** * @brief The serial number of the original copy of the zone. */ @property (readonly, nonatomic) uint32_t serialNumber; -/*! +/** * @brief The refresh interval of the zone. */ @property (readonly, nonatomic) uint32_t refreshInterval; -/*! +/** * @brief The retry interval of the zone. */ @property (readonly, nonatomic) uint32_t retryInterval; -/*! +/** * @brief The expiration interval of the zone. */ @property (readonly, nonatomic) uint32_t expirationInterval; -/*! +/** * @brief The minimum TTL of the zone. */ @property (readonly, nonatomic) uint32_t minTTL; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFSOADNSResourceRecord with the * specified name, class, text data and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record @@ -521,11 +521,11 @@ expirationInterval: (uint32_t)expirationInterval minTTL: (uint32_t)minTTL TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFSRVDNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing an SRV DNS resource record. */ @@ -535,36 +535,36 @@ uint16_t _priority, _weight; OFString *_target; uint16_t _port; } -/*! +/** * @brief The priority of the resource record. */ @property (readonly, nonatomic) uint16_t priority; -/*! +/** * @brief The weight of the resource record. */ @property (readonly, nonatomic) uint16_t weight; -/*! +/** * @brief The target of the resource record. */ @property (readonly, nonatomic) OFString *target; -/*! +/** * @brief The port on the target of the resource record. */ @property (readonly, nonatomic) uint16_t port; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFSRVDNSResourceRecord with the * specified name, class, preference, mail exchange and time to live. * * @param name The name for the resource record * @param priority The priority for the resource record @@ -580,11 +580,11 @@ target: (OFString *)target port: (uint16_t)port TTL: (uint32_t)TTL OF_DESIGNATED_INITIALIZER; @end -/*! +/** * @class OFTXTDNSResourceRecord \ * OFDNSResourceRecord.h ObjFW/OFDNSResourceRecord.h * * @brief A class representing a TXT DNS resource record. */ @@ -592,21 +592,21 @@ @interface OFTXTDNSResourceRecord: OFDNSResourceRecord { OFArray OF_GENERIC(OFData *) *_textStrings; } -/*! +/** * @brief The text of the resource record. */ @property (readonly, nonatomic) OFArray OF_GENERIC(OFData *) *textStrings; - (instancetype)initWithName: (OFString *)name DNSClass: (of_dns_class_t)DNSClass recordType: (of_dns_record_type_t)recordType TTL: (uint32_t)TTL OF_UNAVAILABLE; -/*! +/** * @brief Initializes an already allocated OFTXTDNSResourceRecord with the * specified name, class, text data and time to live. * * @param name The name for the resource record * @param DNSClass The class code for the resource record