From f01c8453d56f810031ded37ed9e37e71e7474089 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Thu, 12 Apr 2018 00:32:03 +0000
Subject:  Document the CAA functions

---
 doc/libs6dns/s6dns-message.html | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'doc/libs6dns/s6dns-message.html')

diff --git a/doc/libs6dns/s6dns-message.html b/doc/libs6dns/s6dns-message.html
index 675dac5..5eb0413 100644
--- a/doc/libs6dns/s6dns-message.html
+++ b/doc/libs6dns/s6dns-message.html
@@ -79,6 +79,7 @@ also provided. The list includes:
  <li> <tt>s6dns_message_rr_mx</tt> for MX RRs </li>
  <li> <tt>s6dns_message_rr_soa</tt> for SOA RRs </li>
  <li> <tt>s6dns_message_rr_srv</tt> for SRV RRs </li>
+ <li> <tt>s6dns_message_rr_caa</tt> for CAA RRs </li>
 </ul>
 
 <h2> Functions </h2>
@@ -167,6 +168,13 @@ Reads a SOA RR and stores it into *<em>p</em>. Returns 1 on success or 0 on fail
 Reads a SRV RR and stores it into *<em>p</em>. Returns 1 on success or 0 on failure.
 </p>
 
+<p>
+<code> int s6dns_message_get_caa (s6dns_message_rr_caa_t *p, char const *packet, unsigned int packetlen, unsigned int *pos, uint16_t rdlength) </code> <br />
+Reads a CAA RR and stores it into *<em>p</em>. Returns 1 on success or 0 on failure.
+<em>rdlength</em> is the length of the RDATA field of the record; this value is
+needed to properly parse a CAA record.
+</p>
+
 <h3> High-level RR-specific parsing functions </h3>
 
 <p>
@@ -233,6 +241,14 @@ Parses SRV RRs located in the answer section of the packet. The
 containing <tt>s6dns_message_rr_srv_t</tt> structures.
 </p>
 
+<p>
+<code> s6dns_message_func_t s6dns_message_parse_answer_caa </code> <br />
+Parses CAA RRs located in the answer section of the packet. The
+<em>data</em> argument is interpreted as a pointer to a
+<a href="//skarnet.org/software/skalibs/libstddjb/genalloc.html">genalloc</a>
+containing <tt>s6dns_message_rr_caa_t</tt> structures.
+</p>
+
 <h3> High-level packet parsing </h3>
 
 <p>
-- 
cgit v1.3.1