From: Miek Gieben Date: Thu, 8 Jun 2006 13:44:23 +0000 (+0000) Subject: more documentation tweaks X-Git-Tag: release-1.1.0~95 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1a600ae8666fc70ac6e8def39db832f413308efb;p=thirdparty%2Fldns.git more documentation tweaks --- diff --git a/doc/function_manpages b/doc/function_manpages index 155e35e0..ede675ed 100644 --- a/doc/function_manpages +++ b/doc/function_manpages @@ -20,7 +20,7 @@ ldns_rr_print, ldns_rdf_print, ldns_pkt_print, ldns_rr_list_print, ldns_resolver ### 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_int16_data, ldns_rdf2buffer_str_int16, ldns_rdf2buffer_str_ipseckey +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_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 @@ -33,7 +33,7 @@ ldns_buffer2pkt_wire ldns_dname_left_chop, ldns_dname_label_count ldns_dname2canonical ldns_dname_cat_clone, ldns_dname_cat -ldns_dname_new,rldns_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_new, 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 ldns_dname_compare, ldns_dname_interval | ldns_dname_is_subdomain ### /dname.h @@ -165,7 +165,7 @@ ldns_pkt_new, ldns_pkt_free, ldns_pkt_print, ldns_pkt_query_new, ldns_pkt_query_ # gets -ldns_pkt_id, ldns_pkt_qr, ldns_pkt_aa, ldns_pkt_tc, ldns_pkt_rd, ldns_pkt_cd, ldns_pkt_ra, ldns_pkt_ad, ldns_pkt_opcode, ldns_pkt_rcode, ldns_pkt_qdcount, ldns_pkt_ancount, ldns_pkt_nscount, ldns_pkt_arcount, ldns_pkt_answerfrom, ldns_pkt_querytime, ldns_pkt_size, ldns_pkt_tsig, ldns_pkt_question, ldns_pkt_answer, ldns_pkt_authority, ldns_pkt_additional, ldns_pkt_get_section, ldns_pkt_rr_list_by_name, ldns_pkt_rr_list_by_type, ldns_pkt_rr_list_by_name_and_type | ldns_pkt +ldns_pkt_id, ldns_pkt_qr, ldns_pkt_aa, ldns_pkt_tc, ldns_pkt_rd, ldns_pkt_cd, ldns_pkt_ra, ldns_pkt_ad, ldns_pkt_get_opcode, ldns_pkt_get_rcode, ldns_pkt_qdcount, ldns_pkt_ancount, ldns_pkt_nscount, ldns_pkt_arcount, ldns_pkt_answerfrom, ldns_pkt_querytime, ldns_pkt_size, ldns_pkt_tsig, ldns_pkt_question, ldns_pkt_answer, ldns_pkt_authority, ldns_pkt_additional, ldns_pkt_get_section_clone, ldns_pkt_rr_list_by_name, ldns_pkt_rr_list_by_type, ldns_pkt_rr_list_by_name_and_type | ldns_pkt # sets ldns_pkt_set_flags, ldns_pkt_set_id, ldns_pkt_set_qr, ldns_pkt_set_aa, ldns_pkt_set_tc, ldns_pkt_set_rd, ldns_pkt_set_cd, ldns_pkt_set_ra, ldns_pkt_set_ad, ldns_pkt_set_opcode, ldns_pkt_set_rcode, ldns_pkt_set_qdcount, ldns_pkt_set_ancount, ldns_pkt_set_nscount, ldns_pkt_set_arcount, ldns_pkt_set_answerfrom, ldns_pkt_set_querytime, ldns_pkt_set_size, ldns_pkt_set_section_count, ldns_pkt_set_tsig | ldns_pkt # EDNS0 @@ -194,4 +194,3 @@ ldns_update_pkt_new | ldns_update_pkt_tsig_add ldns_update_pkt_tsig_add ldns_update_zocount, ldns_update_prcount, ldns_update_upcount, ldns_update_adcount ldns_update_set_zocount, ldns_update_set_prcount, ldns_update_set_upcount, ldns_update_set_adcount -ldns_update_soa_mname, ldns_update_soa_zone_mname diff --git a/ldns/error.h b/ldns/error.h index 29f68db9..c5b54409 100644 --- a/ldns/error.h +++ b/ldns/error.h @@ -82,7 +82,8 @@ typedef enum ldns_enum_status ldns_status; extern ldns_lookup_table ldns_error_str[]; /** - * look up a descriptive text by each error + * look up a descriptive text by each error. This function + * could use a better name * \param[in] err ldns_status number * \return the string for that error */ diff --git a/ldns/packet.h b/ldns/packet.h index cd611a46..3063f145 100644 --- a/ldns/packet.h +++ b/ldns/packet.h @@ -212,15 +212,12 @@ bool ldns_pkt_ra(const ldns_pkt *p); * \return value of the bit */ bool ldns_pkt_ad(const ldns_pkt *p); - -/* conflict with ldns_pkt_opcode type */ /** * Read the packet's code * \param[in] p the packet * \return the opcode */ ldns_pkt_opcode ldns_pkt_get_opcode(const ldns_pkt *p); - /** * Return the packet's respons code * \param[in] p the packet diff --git a/ldns/update.h b/ldns/update.h index d482f583..eba1c9ee 100644 --- a/ldns/update.h +++ b/ldns/update.h @@ -86,9 +86,15 @@ void ldns_update_set_upcount(ldns_pkt *p, uint16_t c); void ldns_update_set_adcount(ldns_pkt *p, uint16_t c); /* soa functions that need to be configured */ -/** TODO */ +/* + * Not sure if we want to keep these like this, therefore + * not documented + */ ldns_status ldns_update_soa_mname(ldns_rdf *zone, ldns_resolver *r, ldns_rr_class class, ldns_rdf **mname); +/* + * Not sure if we want to keep these like this, therefore + * not documented + */ ldns_status ldns_update_soa_zone_mname(const char *fqdn, ldns_resolver *r, ldns_rr_class class, ldns_rdf **zone_rdf, ldns_rdf **mname_rdf); - #endif /* LDNS_UPDATE_H */ diff --git a/libdns.vim b/libdns.vim index d0544b9b..1b6edbb8 100644 --- a/libdns.vim +++ b/libdns.vim @@ -72,6 +72,7 @@ syn keyword ldnsType ldns_pkt syn keyword ldnsType ldns_pkt_section syn keyword ldnsType ldns_pkt_type syn keyword ldnsType ldns_pkt_opcode +syn keyword ldnsType ldns_pkt_rcode syn keyword ldnsConstant LDNS_QR syn keyword ldnsConstant LDNS_AA syn keyword ldnsConstant LDNS_TC