From: Miek Gieben <miekg@NLnetLabs.nl>
Date: Thu, 5 Jan 2006 11:58:27 +0000 (+0000)
Subject: more doc updates
X-Git-Tag: release-1.1.0~490
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=52afca2e4634f30e8b00a4777639269183cfab93;p=thirdparty%2Fldns.git

more doc updates
---

diff --git a/ldns/rr.h b/ldns/rr.h
index 1497e0aa..38843b03 100644
--- a/ldns/rr.h
+++ b/ldns/rr.h
@@ -427,7 +427,14 @@ size_t ldns_rr_list_rr_count(ldns_rr_list *rr_list);
  */
 void ldns_rr_list_set_rr_count(ldns_rr_list *rr_list, size_t count);
 
-/* set a specific rr */
+/**
+ * set a rr on a specific index in a ldns_rr_list
+ * \param[in] rr_list the rr_list to use
+ * \param[in] r the rr to set
+ * \param[in] count index into the rr_list
+ * \return the old rr which was stored in the rr_list, or
+ * NULL is the index was too large
+ * set a specific rr */
 ldns_rr * ldns_rr_list_set_rr(ldns_rr_list *rr_list, ldns_rr *r, size_t count);
 
 /**
@@ -447,14 +454,12 @@ ldns_rr_list* ldns_rr_list_new();
 /**
  * frees an rr_list structure.
  * \param[in] rr_list the list to free
- * \return void
  */
 void ldns_rr_list_free(ldns_rr_list *rr_list);
 
 /**
  * frees an rr_list structure and all rrs contained therein.
  * \param[in] rr_list the list to free
- * \return void
  */
 void ldns_rr_list_deep_free(ldns_rr_list *rr_list);
 
@@ -632,8 +637,6 @@ void ldns_rr_list2canonical(ldns_rr_list *rr_list);
  */
 uint8_t ldns_rr_label_count(ldns_rr *rr);
 
-/* todo */
-
 /**
  * returns the resource record descriptor for the given rr type.
  *
@@ -691,6 +694,7 @@ ldns_rr_list *ldns_rr_list_subtype_by_rdf(ldns_rr_list *l, ldns_rdf *r, size_t p
 ldns_rr_type    ldns_rdf2rr_type(const ldns_rdf *rd);
 
 /* added while doing lua */
+/* TODO document or delete it */
 bool ldns_rr_list_insert_rr(ldns_rr_list *rr_list, ldns_rr *r, size_t count);
 
 #endif /* _LDNS_RR_H */
diff --git a/ldns/tsig.h b/ldns/tsig.h
index c1bb0cd7..7cd140f5 100644
--- a/ldns/tsig.h
+++ b/ldns/tsig.h
@@ -34,8 +34,7 @@ char *ldns_tsig_keydata_clone(ldns_tsig_credentials *);
  *
  * \return true if tsig is correct, false if not, or if tsig is not set
  */
-bool ldns_pkt_tsig_verify(ldns_pkt *pkt, uint8_t *wire, size_t wire_size,
-    const char *key_name, const char *key_data, ldns_rdf *mac);
+bool ldns_pkt_tsig_verify(ldns_pkt *pkt, uint8_t *wire, size_t wire_size, const char *key_name, const char *key_data, ldns_rdf *mac);
 
 /**
  * creates a tsig rr for the given packet and key (string?).
@@ -47,8 +46,6 @@ bool ldns_pkt_tsig_verify(ldns_pkt *pkt, uint8_t *wire, size_t wire_size,
  * \param[in] query_mac is added to the digest if not NULL (so NULL is for signing queries, not NULL is for signing answers)
  * \return status (OK if success)
  */
-ldns_status ldns_pkt_tsig_sign(ldns_pkt *pkt, const char *key_name,
-    const char *key_data, uint16_t fudge, const char *algorithm_name,
-    ldns_rdf *query_mac);
+ldns_status ldns_pkt_tsig_sign(ldns_pkt *pkt, const char *key_name, const char *key_data, uint16_t fudge, const char *algorithm_name, ldns_rdf *query_mac);
 
 #endif /* _LDNS_TSIG_H_ */
diff --git a/ldns/update.h b/ldns/update.h
index 7f629d50..511af097 100644
--- a/ldns/update.h
+++ b/ldns/update.h
@@ -3,7 +3,7 @@
  *
  * Functions for RFC 2136 Dynamic Update
  *
- * Copyright (c) 2005, NLnet Labs. All rights reserved.
+ * Copyright (c) 2005, 2006, NLnet Labs. All rights reserved.
  *
  * See LICENSE for the license.
  */
@@ -11,11 +11,13 @@
 #ifndef _LDNS_UPDATE_H
 #define _LDNS_UPDATE_H
 
-ldns_pkt	*ldns_update_pkt_new(ldns_rdf *, ldns_rr_class, ldns_rr_list *,
-    ldns_rr_list *, ldns_rr_list *);
+/**
+ *
+ */
+
+ldns_pkt	*ldns_update_pkt_new(ldns_rdf *, ldns_rr_class, ldns_rr_list *, ldns_rr_list *, ldns_rr_list *);
 ldns_status	ldns_update_pkt_tsig_add(ldns_pkt *, ldns_resolver *);
-ldns_resolver	*ldns_update_resolver_new(const char *, const char *,
-    ldns_rr_class, ldns_tsig_credentials *, ldns_rdf **);
+ldns_resolver	*ldns_update_resolver_new(const char *, const char *, ldns_rr_class, ldns_tsig_credentials *, ldns_rdf **);
 
 uint16_t ldns_update_get_zo(const ldns_pkt *);
 uint16_t ldns_update_get_pr(const ldns_pkt *);