From: Miek Gieben <miekg@NLnetLabs.nl>
Date: Mon, 12 Sep 2005 12:39:41 +0000 (+0000)
Subject: added missing doxygen definitions
X-Git-Tag: release-1.0.0~158
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a4cc09ba24f2192e1e66bc0fcc195f5c070b740f;p=thirdparty%2Fldns.git

added missing doxygen definitions
---

diff --git a/ldns/dnssec.h b/ldns/dnssec.h
index efd88116..dabfc317 100644
--- a/ldns/dnssec.h
+++ b/ldns/dnssec.h
@@ -45,7 +45,7 @@ typedef enum ldns_enum_algorithm ldns_algorithm;
 /** 
  * calculates a keytag of a key for use in DNSSEC.
  *
- * \param[in] key the key to use for the calc.
+ * \param[in] key the key as an RR to use for the calc.
  * \return the keytag
  */
 uint16_t ldns_calc_keytag(ldns_rr *key);
@@ -56,21 +56,22 @@ uint16_t ldns_calc_keytag(ldns_rr *key);
  * \param[in] rrset the rrset to verify
  * \param[in] rrsig a list of signatures to check
  * \param[in] keys a list of keys to check with
- * \param[out] good_keys, if this is a (initialized) list, the keys from keys that validate one of the signatures are added to it
+ * \param[out] good_keys  if this is a (initialized) list, the keys from keys that validate one of the signatures are added to it
  * \return status LDNS_STATUS_OK if there is at least one correct key
  */
 ldns_status ldns_verify(ldns_rr_list *rrset, ldns_rr_list *rrsig, ldns_rr_list *keys, ldns_rr_list *good_keys);	
 
 /**
  * Verifies an rrsig. All keys in the keyset are tried.
- *
  * \param[in] rrset the rrset to check
  * \param[in] rrsig the signature of the rrset
  * \param[in] keys the keys to try
- * \return a list of keys which validate the rrsig + rrset. Return NULL
- * when none of the keys validate.
+ * \param[out] good_keys  if this is a (initialized) list, the keys from keys that validate one of the signatures are added to it
+ * \return a list of keys which validate the rrsig + rrset. Return NULL when none of the keys validate.
  */
 ldns_status ldns_verify_rrsig_keylist(ldns_rr_list *rrset, ldns_rr *rrsig, ldns_rr_list *keys, ldns_rr_list *good_keys);
+
+
 ldns_status ldns_verify_rrsig(ldns_rr_list *rrset, ldns_rr *rrsig, ldns_rr *key);
 
 /**
diff --git a/ldns/host2wire.h b/ldns/host2wire.h
index 8790b97b..c0868620 100644
--- a/ldns/host2wire.h
+++ b/ldns/host2wire.h
@@ -71,7 +71,7 @@ ldns_status ldns_pkt2buffer_wire(ldns_buffer *output, const ldns_pkt *pkt);
 /**
  * Copies the rr_list data to the buffer in wire format
  * \param[out] *output buffer to append the result to
- * \param[in] *rr_list rr_list to to convert
+ * \param[in] *rrlist rr_list to to convert
  * \return ldns_status
  */
 ldns_status ldns_rr_list2buffer_wire(ldns_buffer *output, ldns_rr_list *rrlist);
diff --git a/ldns/keys.h b/ldns/keys.h
index 60ef817c..391ec7d7 100644
--- a/ldns/keys.h
+++ b/ldns/keys.h
@@ -251,9 +251,8 @@ void ldns_key_free(ldns_key *key);
 void ldns_key_deep_free(ldns_key *key);
 
 /**
- * frees a key list structure
- *
- * \param[in] key the key list object to free
+ * Frees a key list structure
+ * \param[in] key_list the key list object to free
  */
 void ldns_key_list_free(ldns_key_list *key_list);
 
diff --git a/ldns/net.h b/ldns/net.h
index c25f0586..8e9091a5 100644
--- a/ldns/net.h
+++ b/ldns/net.h
@@ -122,6 +122,8 @@ uint8_t *ldns_tcp_read_wire(int sockfd, size_t *size);
  * socket. Allocates the data (of size size) itself, so don't forget to free
  *
  * \param[in] sockfd the socket to read from
+ * \param[in] fr the address of the client (if applicable)
+ * \param[in] *frlen the lenght of the client's addr (if applicable)
  * \param[out] size the number of bytes that are read
  * \return the data read
  */
diff --git a/ldns/wire2host.h b/ldns/wire2host.h
index d002a0b2..3d140cfe 100644
--- a/ldns/wire2host.h
+++ b/ldns/wire2host.h
@@ -123,7 +123,7 @@ ldns_status ldns_wire2pkt(ldns_pkt **packet, const uint8_t *data, size_t len);
  * structure.
  * 
  * \param[in] packet pointer to the structure to hold the packet
- * \param[in] buffera the buffer with the data
+ * \param[in] buffer the buffer with the data
  * \return LDNS_STATUS_OK if everything succeeds, error otherwise
  */
 ldns_status ldns_buffer2pkt_wire(ldns_pkt **packet, ldns_buffer *buffer);