added gnutls backend and moved backend code into new files

[ircu2.10.12-pk.git] / include / ircd_reslib.h

diff --git a/include/ircd_reslib.h b/include/ircd_reslib.h
index c42be748296d5db92198b3b75817cfd62781b37a..fae4156bf88709bfde44a4c5fa61f94dde89b576 100644 (file)
--- a/include/ircd_reslib.h
+++ b/include/ircd_reslib.h
@@ -1,8 +1,10 @@
 /*
  * include/ircd_reslib.h
  * (C)opyright 1992 Darren Reed.
- *
- * $Id$
+ */
+/** @file
+ * @brief Interface from ircd resolver to its support functions.
+ * @version $Id$
  */
 #ifndef INCLUDED_ircdreslib_h
 #define INCLUDED_ircdreslib_h
@@ -12,6 +14,7 @@
 /*
  * Inline versions of get/put short/long.  Pointer is advanced.
  */
+/** Get a 16-bit network endian value from \a cp and assign to \a s. */
 #define IRC_NS_GET16(s, cp) { \
        const unsigned char *t_cp = (const unsigned char *)(cp); \
        (s) = ((uint16_t)t_cp[0] << 8) \
@@ -20,6 +23,7 @@
        (cp) += NS_INT16SZ; \
 }
 
+/** Get a 32-bit network endian value from \a cp and assign to \a s. */
 #define IRC_NS_GET32(l, cp) { \
        const unsigned char *t_cp = (const unsigned char *)(cp); \
        (l) = ((uint32_t)t_cp[0] << 24) \
@@ -30,6 +34,7 @@
        (cp) += NS_INT32SZ; \
 }
 
+/** Put \a s at \a cp as a 16-bit network endian value. */
 #define IRC_NS_PUT16(s, cp) { \
        uint16_t t_s = (uint16_t)(s); \
        unsigned char *t_cp = (unsigned char *)(cp); \
@@ -38,6 +43,7 @@
        (cp) += NS_INT16SZ; \
 }
 
+/** Put \a s at \a cp as a 32-bit network endian value. */
 #define IRC_NS_PUT32(l, cp) { \
        uint32_t t_l = (uint32_t)(l); \
        unsigned char *t_cp = (unsigned char *)(cp); \
@@ -48,6 +54,7 @@
        (cp) += NS_INT32SZ; \
 }
 
+/** Maximum number of nameservers to bother with. */
 #define IRCD_MAXNS 8
 
 int irc_res_init(void);