From: Jelte Jansen <jelte@NLnetLabs.nl>
Date: Mon, 9 Feb 2009 21:04:44 +0000 (+0000)
Subject: doxygen fixlets
X-Git-Tag: release-1.5.0~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e12da5e500ac5b8b018a157860e2ef9ea8a613ce;p=thirdparty%2Fldns.git

doxygen fixlets
---

diff --git a/ldns/dnssec_sign.h b/ldns/dnssec_sign.h
index 6c0c7737..a4a63c06 100644
--- a/ldns/dnssec_sign.h
+++ b/ldns/dnssec_sign.h
@@ -10,7 +10,7 @@
 /**
  * Create an empty RRSIG RR (i.e. without the actual signature data)
  * \param[in] rrset The RRset to create the signature for
- * \param[in] current_key The key that will create the signature
+ * \param[in] key The key that will create the signature
  * \return signature rr
  */
 ldns_rr *
diff --git a/ldns/keys.h b/ldns/keys.h
index 67abc941..c2c833ee 100644
--- a/ldns/keys.h
+++ b/ldns/keys.h
@@ -320,12 +320,13 @@ void ldns_key_set_hmac_size(ldns_key *k, size_t hmac_size);
  * Set the key id data. This is used if the key points to
  * some externally stored key data
  * 
- * The data at the pointer is not copied, and must be freed
- * manually; ldns_key_deep_free() does *not* free this data
- * \param[in] k the key
- * \param[in] hmac key id data
+ * Only the pointer is set, the data there is not copied,
+ * and must be freed manually; ldns_key_deep_free() does 
+ * *not* free this data
+ * \param[in] key the key
+ * \param[in] external_key key id data
  */
-void ldns_key_set_external_key(ldns_key *k, void *external_key);
+void ldns_key_set_external_key(ldns_key *key, void *external_key);
 
 /**
  * Set the key's hmac size
@@ -558,7 +559,7 @@ ldns_rr * ldns_read_anchor_file(const char *filename);
 
 /**
  * Returns the 'default base name' for key files;
- * IE. K<zone>+<alg>+<keytag>
+ * IE. K\<zone\>+\<alg\>+\<keytag\>
  * (without the .key or .private)
  * The memory for this is allocated by this function,
  * and should be freed by the caller
diff --git a/ldns/util.h.in b/ldns/util.h.in
index 35ab7485..a09b8610 100644
--- a/ldns/util.h.in
+++ b/ldns/util.h.in
@@ -282,8 +282,8 @@ int ldns_init_random(FILE *fd, unsigned int size);
 /**
  * Encode data as BubbleBabble
  *
- * \param[in] a pointer to data to be encoded
- * \param[in] size the number of bytes of data
+ * \param[in] data a pointer to data to be encoded
+ * \param[in] len size the number of bytes of data
  * \return a string of BubbleBabble
  */
 char *ldns_bubblebabble(uint8_t *data, size_t len);