From 8b975533e544a5cbaae2a45e2fc7710eafcd2c19 Mon Sep 17 00:00:00 2001 From: Evelyn Date: Mon, 25 Jul 2016 17:15:49 +0100 Subject: [PATCH] Update mg_dns_encode_record.md --- docs/c-api/dns.h/mg_dns_encode_record.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/c-api/dns.h/mg_dns_encode_record.md b/docs/c-api/dns.h/mg_dns_encode_record.md index 4b8a9850..a892e5de 100644 --- a/docs/c-api/dns.h/mg_dns_encode_record.md +++ b/docs/c-api/dns.h/mg_dns_encode_record.md @@ -8,11 +8,11 @@ signature: | size_t rlen); --- -Encode and append a DNS resource record to an IO buffer. +Encodes and appends a DNS resource record to an IO buffer. The record metadata is taken from the `rr` parameter, while the name and data are taken from the parameters, encoded in the appropriate format depending on -record type, and stored in the IO buffer. The encoded values might contain +record type and stored in the IO buffer. The encoded values might contain offsets within the IO buffer. It's thus important that the IO buffer doesn't get trimmed while a sequence of records are encoded while preparing a DNS *reply. @@ -21,5 +21,5 @@ This function doesn't update the `name` and `rdata` pointers in the `rr` *struct because they might be invalidated as soon as the IO buffer grows again. -Return the number of bytes appened or -1 in case of error. +Returns the number of bytes appened or -1 in case of error.