manual pages cleanup

diff --git a/doc/function_manpages b/doc/function_manpages
index 6fa2940ec49daa9942823c192d2a1a8c4cabad21..c7f8094e8d5a3af1a3d440d7a44b45e52e7aa569 100644 (file)
--- a/doc/function_manpages
+++ b/doc/function_manpages
@@ -5,29 +5,91 @@
 
 # functions that must be included, separated by commas
 
+### host2wire.h
 # conversion functions
-ldns_rr2wire, ldns_pkt2wire, ldns_rdf2wire, ldns_rr2str, ldns_pkt2str, ldns_rdf2str | Miek Gieben, Jelte Jansen
+ldns_rr2wire, ldns_pkt2wire, ldns_rdf2wire, ldns_rr2str, ldns_pkt2str, ldns_rdf2str
 
-# lower level conversions
-ldns_pkt2buffer_str, ldns_rr2buffer_str, ldns_rdf2buffer_str, ldns_pkt2buffer_wire, ldns_rr2buffer_wire, ldns_rdf2buffer_wire,
+# lower level conversions, some are from host2str.h
+ldns_pkt2buffer_str, ldns_pktheader2buffer_str, ldns_rr2buffer_str, ldns_rr_list2buffer_str, ldns_rdf2buffer_str, ldns_key2buffer_str, ldns_pkt2buffer_wire, ldns_rr2buffer_wire, ldns_rdf2buffer_wire, ldns_rrsig2buffer_wire, ldns_rr_rdata2buffer_wire
+### /host2wire.h
 
+### host2str.h
 # and even lower
-ldns_rdf2buffer_str_a, ldns_rdf2buffer_str_aaaa, ldns_rdf2buffer_str_str, ldns_rdf2buffer_str_b64, ldns_rdf2buffer_str_hex, ldns_rdf2buffer_str_type, ldns_rdf2buffer_str_class, ldns_rdf2buffer_str_alg, ldns_rdf2buffer_str_cert, ldns_rdf2buffer_str_loc, ldns_rdf2buffer_str_unknown, ldns_rdf2buffer_str_nsap, ldns_rdf2buffer_str_wks, ldns_rdf2buffer_str_nsec, ldns_rdf2buffer_str_period, ldns_rdf2buffer_str_tsigtime, ldns_rdf2buffer_str_apl, ldns_rdf2buffer_str_todo, ldns_rdf2buffer_str_int16_data, ldns_rdf2buffer_str_ipseckey, ldns_rdf2buffer_str_tsig
+ldns_rdf2buffer_str_a, ldns_rdf2buffer_str_aaaa, ldns_rdf2buffer_str_str, ldns_rdf2buffer_str_b64, ldns_rdf2buffer_str_hex, ldns_rdf2buffer_str_type, ldns_rdf2buffer_str_class, ldns_rdf2buffer_str_alg, ldns_rdf2buffer_str_cert, ldns_rdf2buffer_str_loc, ldns_rdf2buffer_str_unknown, ldns_rdf2buffer_str_nsap, ldns_rdf2buffer_str_wks, ldns_rdf2buffer_str_nsec, ldns_rdf2buffer_str_period, ldns_rdf2buffer_str_tsigtime, ldns_rdf2buffer_str_apl, ldns_rdf2buffer_str_int16_data, ldns_rdf2buffer_str_int16, ldns_rdf2buffer_str_ipseckey
+### /host2str.h
 
+### wire2host.h
 # wirefunctions
 ldns_wire2rr, ldns_wire2pkt, ldns_wire2rdf, ldns_wire2dname
+ldns_buffer2pkt_wire
+### /wire2host.h
+
+### dname.h
+ldns_dname_left_chop, ldns_dname_label_count
+ldns_dname2canonical
+ldns_dname_cat_clone, ldns_dname_cat
+ldns_dname_new_frm_str, ldns_dname_new_frm_data | ldns_pkt_query_new_frm_str, ldns_rdf_new_frm_str, ldns_rr_new_frm_str
+ldns_dname_is_subdomain, ldns_dname_str_absolute, ldns_dname_label
+### /dname.h
+
+### rdata.h
+ldns_rdf, ldns_rdf_type | ldns_rdf_set_size, ldns_rdf_size, ldns_rdf_new, ldns_native2rdf_int8, ldns_rdf_address_reverse, ldns_octet
+ldns_rdf_set_size, ldns_rdf_set_type, ldns_rdf_set_data | ldns_rdf
+ldns_rdf_size, ldns_rdf_get_type, ldns_rdf_data | ldns_rdf
+ldns_rdf_new, ldns_rdf_new_frm_data, ldns_rdf_new_frm_str, ldns_rdf_new_frm_fp, ldns_rdf_free, ldns_rdf_deep_free, ldns_rdf_print | ldns_rdf
+ldns_native2rdf_int8, ldns_native2rdf_int16, ldns_native2rdf_int32,ldns_native2rdf_int16_data, ldns_rdf2native_int8, ldns_rdf2native_int16, ldns_rdf2native_int32, ldns_rdf2native_sockaddr_storage | ldns_rdf
+ldns_rdf_address_reverse | ldns_rdf
+ldns_octet | ldns_rdf
+# why is this in rdata.h?
+ldns_str2period
+ldns_rdf_clone
+ldns_rdf_compare
+### /rdata.h
 
-# dname.h
-ldns_dname_cat, ldns_dname_left_chop, ldns_dname_label_count, ldns_dname_new_frm_str,ldns_dname_new_frm_data, ldns_dname2canonical
+### higher.h
+ldns_get_rr_list_addr_by_name, ldns_get_rr_list_name_by_addr
+ldns_get_rr_list_hosts_frm_fp, ldns_get_rr_list_hosts_frm_file | ldns_get_rr_list_hosts_frm_fp_l
+ldns_get_rr_list_hosts_frm_fp_l
+ldns_getaddrinfo
+### /higher.h
 
-# dnssec.h
+### dnssec.h
 ldns_calc_keytag, ldns_verify, ldns_verify_rrsig, ldns_verify_rrsig_dsa, ldns_verify_rrsig_rsasha1, ldns_verify_rrsig_rsamd5, ldns_key_rr2ds, ldns_key_buf2dsa, ldns_key_buf2rsa
-
-#      verify
-ldns_verify, ldns_verify_rrsig, ldns_verify_rrsig_dsa, ldns_verify_rrsig_rsasha1, ldns_verify_rrsig_rsamd5
-
-# dnskey.h
-ldns_key_new, ldns_key_new_frm_algorithm, ldns_key2rr,
+# algs
+ldns_verify_rrsig_dsa, ldns_verify_rrsig_rsasha1, ldns_verify_rrsig_rsamd5
+# tsig
+ldns_pkt_tsig_verify, ldns_pkt_tsig_sign
+# verify
+ldns_verify, ldns_verify_rrsig, ldns_verify_rrsig_keylist | ldns_verify_rrsig_dsa, ldns_verify_rrsig_rsasha1, ldns_verify_rrsig_rsamd5
+# convert
+ldns_key_buf2dsa, ldns_key_buf2rsa | ldns_key_rr2ds
+ldns_key_rr2ds
+# signing
+ldns_sign_public | ldns_sign_public_dsa, ldns_sign_public_rsamd5, ldns_sign_public_rsasha1, ldns_sign_public_dsa
+ldns_sign_public_dsa, ldns_sign_public_rsamd5, ldns_sign_public_rsasha1, ldns_sign_public_dsa
+ldns_zone_sign
+ldns_init_random
+#ldns_pkt_verify
+### /dnssec.h
+
+### dnskey.h
+ldns_key_new | ldns_key_list_new
+ldns_key_new_frm_algorithm, ldns_key_new_frm_fp, ldns_key_new_frm_fp_l
+ldns_key_new_frm_fp_rsa, ldns_key_new_frm_fp_rsa_l | ldns_key_new_frm_fp
+ldns_key_new_frm_fp_dsa, ldns_key_new_frm_fp_dsa_l | ldns_key_new_frm_fp
+ldns_key_list_new | ldns_key_new
+# access, write
+ldns_key_set_algorithm, ldns_key_set_rsa_key, ldns_key_set_dsa_key, ldns_key_set_hmac_key, ldns_key_set_origttl, ldns_key_set_inception, ldns_key_set_expiration, ldns_key_set_pubkey_owner, ldns_key_set_keytag, ldns_key_set_flags, ldns_key_list_set_key_count | ldns_key_push_key
+ldns_key_list_push_key | ldns_key_list_pop_key
+ldns_key_list_pop_key | ldns_key_list_push_key
+# access, read
+ldns_key_list_key_count, ldns_key_list_key, ldns_key_rsa_key, ldns_key_dsa_key, ldns_key_algorithm, ldns_key_hmac_key, ldns_key_origttl, ldns_key_inception, ldns_key_expiration, ldns_key_keytag, ldns_key_pubkey_owner, ldns_key_flags
+# convert
+ldns_key2rr
+ldns_key_free, ldns_key_deep_free, ldns_key_list_free
+### /dnskey.h
+
+### MIEK TOT HIER TOT HIER
 
 #      lists
 ldns_key_list_new, ldns_key_list_push_key,  ldns_key_list_pop_key, ldns_key_list_key_count, ldns_key_list_key
@@ -37,24 +99,15 @@ ldns_key_rsa_key, ldns_key_dsa_key, ldns_key_algorithm, ldns_key_hmac_key
 ldns_key_origttl, ldns_key_inception, ldns_key_expiration, ldns_key_keytag, ldns_key_pubkey_owner, ldns_key_flags
 ldns_key_set_algorithm, ldns_key_set_rsa_key, ldns_key_set_dsa_key, ldns_key_set_hmac_key, ldns_key_set_origttl, ldns_key_set_inception, ldns_key_set_expiration, ldns_key_set_pubkey_owner, ldns_key_set_keytag, ldns_key_set_flags, ldns_key_list_set_key_count, 
 
-# TSIG
-ldns_pkt_tsig_verify, ldns_pkt_tsig_sign
-
-# DNSSEC sign function; not yet!
-
 # errr.h
 ldns_get_errorstr_by_id
 
-# higher.h
-ldns_get_rr_list_addr_by_name, ldns_get_rr_list_name_by_addr
-ldns_get_rr_list_hosts_frm_fp, ldns_get_rr_list_hosts_frm_file
-
-# net.h
+### net.h
 ldns_send_udp, ldns_send_tcp, ldns_send
 ldns_tcp_send_query, ldns_tcp_read_wire, ldns_tcp_connect
+### /net.h
 
-# buffer.h
-
+### buffer.h
 # general
 ldns_buffer, ldns_buffer_new, ldns_buffer_new_frm_data, ldns_buffer_clear, ldns_buffer_printf, ldns_buffer_free, ldns_buffer_export
 # position
@@ -65,24 +118,13 @@ ldns_buffer_limit, ldns_buffer_set_limit, ldns_buffer_capacity, ldns_buffer_set_
 ldns_buffer_remaining_at, ldns_buffer_remaining, ldns_buffer_available_at, ldns_buffer_available, ldns_buffer_status, ldns_buffer_status_ok
 # read and write
 ldns_buffer_write_at, ldns_buffer_write_at, ldns_buffer_write, ldns_buffer_write_string_at, ldns_buffer_write_string, ldns_buffer_write_u8_at, ldns_buffer_write_u8, ldns_buffer_write_u16_at, ldns_buffer_write_u16, ldns_buffer_read_at, ldns_buffer_read, ldns_buffer_read_u8_at, ldns_buffer_read_u8, ldns_buffer_read_u16_at, ldns_buffer_read_u16, ldns_buffer_read_u32_at, ldns_buffer_read_u32
+### /buffer.h
 
 # parse.h
 ldns_bget_token, ldns_bgetc, ldns_bskipcs | ldns_buffer
 ldns_fget_token, ldns_fskipcs
 ldns_str_remove_comment
 
-# rdata.h
-ldns_rdf, ldns_rdf_type | ldns_rdf_set_size, ldns_rdf_size, ldns_rdf_new, ldns_native2rdf_int8, ldns_rdf_address_reverse, ldns_octet
-ldns_rdf_set_size, ldns_rdf_set_type, ldns_rdf_set_data | ldns_rdf
-ldns_rdf_size, ldns_rdf_get_type, ldns_rdf_data | ldns_rdf
-ldns_rdf_new, ldns_rdf_new_frm_data, ldns_rdf_new_frm_str, ldns_rdf_new_frm_fp, ldns_rdf_free, ldns_rdf_deep_free, ldns_rdf_print | ldns_rdf
-ldns_native2rdf_int8, ldns_native2rdf_int16, ldns_native2rdf_int32,ldns_native2rdf_int16_data, ldns_rdf2native_int8, ldns_rdf2native_int16, ldns_rdf2native_int32, ldns_rdf2native_sockaddr_storage | ldns_rdf
-ldns_rdf_address_reverse | ldns_rdf
-ldns_octet | ldns_rdf
-# why is this in rdata.h?
-ldns_str2period
-ldns_rdf_clone
-ldns_rdf_compare
 
 # rr.h and other general rr funcs
 ldns_rr, ldns_rr_class, ldns_rr_type, ldns_rr_compress, ldns_rr_list | ldns_rr_new, ldns_rr_set_owner, ldns_rr_push_rdf, ldns_rr_rdf, ldns_rr_list_rr_count, ldns_rr_list_new, ldns_rr_list_cat, ldns_is_rrset, ldns_rr_set_push_rr, ldns_get_rr_class_by_name, ldns_rr_list_clone, ldns_rr_list_sort, ldns_rr_compare, ldns_rr_uncompressed_size, ldns_rr2canonical, ldns_rr_label_count, ldns_rr_descriptor
@@ -118,9 +160,6 @@ ldns_pkt_set_flags, ldns_pkt_set_id, ldns_pkt_set_qr, ldns_pkt_set_aa, ldns_pkt_
 #      EDNS0
 ldns_pkt_edns, ldns_pkt_edns_udp_size, ldns_pkt_edns_extended_rcode, ldns_pkt_edns_version, ldns_pkt_edns_z, ldns_pkt_edns_data, ldns_pkt_set_edns_udp_size, ldns_pkt_set_edns_extended_rcode, ldns_pkt_set_edns_version, ldns_pkt_set_edns_z, ldns_pkt_set_edns_data | ldns_pkt
 
-
-
-
 # rr_functions.h
 ldns_rr_address, ldns_rr_set_address
 #

diff --git a/ldns/dname.h b/ldns/dname.h
index bb3cd63f84a8dbcc989265952706e3ba71937465..e7d54e6b98c84efca49ee6ac35d9aed7b902fd2c 100644 (file)
--- a/ldns/dname.h
+++ b/ldns/dname.h
@@ -24,7 +24,7 @@
  * \param[in] rd2 the rightside
  * \return a new rdf with leftside/rightside
  */
-ldns_rdf       *ldns_dname_cat_clone(ldns_rdf *rd1, ldns_rdf *rd2);
+ldns_rdf *ldns_dname_cat_clone(ldns_rdf *rd1, ldns_rdf *rd2);
 /**
  * concatenates rd2 after rd1 (rd2 is copied, rd1 is modified)
  * \param[in] rd1 the leftside
@@ -38,20 +38,20 @@ ldns_status         ldns_dname_cat(ldns_rdf *rd1, ldns_rdf *rd2);
  * \param[in] d the dname to chop
  * \return the remaining dname
  */
-ldns_rdf       *ldns_dname_left_chop(ldns_rdf *d);
+ldns_rdf *ldns_dname_left_chop(ldns_rdf *d);
 /**
  * count the number of labels inside a LDNS_RDF_DNAME type rdf.
  * \param[in] *r the rdf
  * \return the number of labels
  */     
-uint8_t         ldns_dname_label_count(const ldns_rdf *r);
+uint8_t  ldns_dname_label_count(const ldns_rdf *r);
 
 /**
  * Create a new dname rdf. Copies pointers!
  * \param[in] str string to use
  * \return ldns_rdf*
  */
-ldns_rdf       *ldns_dname_new_frm_str(const char *str);
+ldns_rdf *ldns_dname_new_frm_str(const char *str);
 
 /**
  * Create a new dname rdf from a string
@@ -59,7 +59,7 @@ ldns_rdf      *ldns_dname_new_frm_str(const char *str);
  * \param[in] *data pointer to the actual data
  * \return ldns_rdf*
  */
-ldns_rdf       *ldns_dname_new(uint16_t s, void *data);
+ldns_rdf *ldns_dname_new(uint16_t s, void *data);
 
 /**
  * Create a new dname rdf from data (the data is copied)
@@ -67,7 +67,7 @@ ldns_rdf      *ldns_dname_new(uint16_t s, void *data);
  * \param[in] *data pointer to the actual data
  * \return ldns_rdf*
  */
-ldns_rdf       *ldns_dname_new_frm_data(uint16_t size, const void *data);
+ldns_rdf *ldns_dname_new_frm_data(uint16_t size, const void *data);
 
 /**
  * Put a dname into canonical fmt - ie. lowercase it
@@ -87,6 +87,8 @@ bool ldns_dname_is_subdomain(const ldns_rdf *sub, const ldns_rdf *parent);
 
 /**
  * Checks whether the given dname string is absolute (i.e. ends with a '.')
+ * \param[in] *dname_str a string representing the dname
+ * \return true or false
  */
 bool ldns_dname_str_absolute(const char *dname_str);
 

diff --git a/ldns/host2wire.h b/ldns/host2wire.h
index a04772836b25b91f210b14ac50da94b5d7fec419..8790b97bfd3d84f06ff7a3d9e3392cd75c716a36 100644 (file)
--- a/ldns/host2wire.h
+++ b/ldns/host2wire.h
@@ -68,8 +68,13 @@ ldns_status ldns_rr_rdata2buffer_wire(ldns_buffer *output, ldns_rr *rr);
  */
 ldns_status ldns_pkt2buffer_wire(ldns_buffer *output, const ldns_pkt *pkt);
 
-
-ldns_status ldns_rr_list2buffer_wire(ldns_buffer *buf, ldns_rr_list *rrlist);
+/**
+ * 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
+ * \return ldns_status
+ */
+ldns_status ldns_rr_list2buffer_wire(ldns_buffer *output, ldns_rr_list *rrlist);
 
 /**
  * Allocates an array of uint8_t at dest, and puts the wireformat of the

diff --git a/ldns/keys.h b/ldns/keys.h
index 8536cf6699c1a5f5b5861912b60da3c71abda259..60ef817cf4e597277f1a4374613a0379b79da1bc 100644 (file)
--- a/ldns/keys.h
+++ b/ldns/keys.h
@@ -257,6 +257,4 @@ void ldns_key_deep_free(ldns_key *key);
  */
 void ldns_key_list_free(ldns_key_list *key_list);
 
-
-
 #endif /* _LDNS_KEYS_H */