- * @param forward Set to true to perform a forward lookup (hostname to ip) or false
- * to perform a reverse lookup (ip to hostname). Lookups on A records and PTR
- * records are supported. CNAME and MX are not supported by this resolver.
- * If InspIRCd is compiled with ipv6 support, lookups on AAAA records are preferred
- * and supported over A records.
+ * @param qt The query type to perform. If you just want to perform a forward
+ * or reverse lookup, and you don't care wether you get ipv4 or ipv6, then use
+ * the constants DNS_QUERY_FORWARD and DNS_QUERY_REVERSE, which automatically
+ * select from 'A' record or 'AAAA' record lookups. However, if you want to resolve
+ * a specific record type, resolution of 'A', 'AAAA', 'PTR' and 'CNAME' records
+ * is supported. Use one of the QueryType enum values to initiate this type of
+ * lookup. Resolution of 'AAAA' ipv6 records is always supported, regardless of
+ * wether InspIRCd is built with ipv6 support.
+ * If you attempt to resolve a 'PTR' record using DNS_QUERY_PTR, and InspIRCd is
+ * built with ipv6 support, the 'PTR' record will be formatted to ipv6 specs,
+ * e.g. x.x.x.x.x....ip6.arpa. otherwise it will be formatted to ipv4 specs,
+ * e.g. x.x.x.x.in-addr.arpa. This translation is automatic.
+ * To get around this automatic behaviour, you must use one of the values
+ * DNS_QUERY_PTR4 or DNS_QUERY_PTR6 to force ipv4 or ipv6 behaviour on the lookup,
+ * irrespective of what protocol InspIRCd has been built for.
+ * @param cached The constructor will set this boolean to true or false depending
+ * on whether the DNS lookup you are attempting is cached (and not expired) or not.
+ * If the value is cached, upon return this will be set to true, otherwise it will
+ * be set to false. You should pass this value to InspIRCd::AddResolver(), which
+ * will then influence the behaviour of the method and determine whether a cached
+ * or non-cached result is obtained. The value in this variable is always correct
+ * for the given request when the constructor exits.
+ * @param creator See the note below.