From: Wouter Wijngaards Date: Fri, 13 Aug 2010 08:41:49 +0000 (+0000) Subject: add and fix doxygen comments for doxygen-1.7.1. (which reports lots of X-Git-Tag: release-1.4.7rc1~114 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=40f8fe2815be9ac207884e5ddf51f174f0702ad6;p=thirdparty%2Funbound.git add and fix doxygen comments for doxygen-1.7.1. (which reports lots of spurious items as well, by the way). git-svn-id: file:///svn/unbound/trunk@2211 be551aaa-1e26-0410-a405-d3ace91eadb9 --- diff --git a/daemon/worker.c b/daemon/worker.c index 210b20435..cfb484a67 100644 --- a/daemon/worker.c +++ b/daemon/worker.c @@ -283,9 +283,10 @@ worker_handle_service_reply(struct comm_point* c, void* arg, int error, return 0; } -/** check request sanity. Returns error code, 0 OK, or -1 discard. +/** check request sanity. * @param pkt: the wire packet to examine for sanity. * @param worker: parameters for checking. + * @return error code, 0 OK, or -1 discard. */ static int worker_check_request(ldns_buffer* pkt, struct worker* worker) diff --git a/doc/Changelog b/doc/Changelog index 766f329fd..bd55f2a39 100644 --- a/doc/Changelog +++ b/doc/Changelog @@ -1,5 +1,6 @@ 13 August 2010: Wouter - More pleasant remote control command parsing. + - documentation added for return values reported by doxygen 1.7.1. 9 August 2010: Wouter - Fix name of rrset printed that failed validation. diff --git a/iterator/iter_delegpt.h b/iterator/iter_delegpt.h index b779abc94..266322fb8 100644 --- a/iterator/iter_delegpt.h +++ b/iterator/iter_delegpt.h @@ -185,7 +185,7 @@ int delegpt_add_ns(struct delegpt* dp, struct regional* regional, * @param regional: where to allocate the info. * @param ns_rrset: NS rrset. * @param lame: rrset is lame, disprefer it. - * return 0 on alloc error. + * @return 0 on alloc error. */ int delegpt_rrset_add_ns(struct delegpt* dp, struct regional* regional, struct ub_packed_rrset_key* ns_rrset, int lame); diff --git a/iterator/iter_utils.h b/iterator/iter_utils.h index 58ba5a920..deddac666 100644 --- a/iterator/iter_utils.h +++ b/iterator/iter_utils.h @@ -159,6 +159,7 @@ void iter_mark_pside_cycle_targets(struct module_qstate* qstate, * @param qinfo: query name and type * @param qflags: query flags with RD flag * @param dp: delegpt to check. + * @return true if dp is useless. */ int iter_dp_is_useless(struct query_info* qinfo, uint16_t qflags, struct delegpt* dp); diff --git a/iterator/iterator.c b/iterator/iterator.c index bd1fea1d7..e61829762 100644 --- a/iterator/iterator.c +++ b/iterator/iterator.c @@ -534,6 +534,7 @@ generate_sub_request(uint8_t* qname, size_t qnamelen, uint16_t qtype, * @param ie: iterator global state. * @param id: module id. * @param qclass: the class to prime. + * @return 0 on failure */ static int prime_root(struct module_qstate* qstate, struct iter_qstate* iq, diff --git a/pythonmod/pythonmod_utils.h b/pythonmod/pythonmod_utils.h index 2aa8f7572..a1641d308 100644 --- a/pythonmod/pythonmod_utils.h +++ b/pythonmod/pythonmod_utils.h @@ -74,6 +74,7 @@ void invalidateQueryInCache(struct module_qstate* qstate, struct query_info* qin * * @param qstate: module environment * @param pkt: a ldns_buffer which contains ldns_packet data + * @return 0 on failure, out of memory or parse error. */ int createResponse(struct module_qstate* qstate, ldns_buffer* pkt); diff --git a/testcode/fake_event.c b/testcode/fake_event.c index 15c1ef527..35fdf4507 100644 --- a/testcode/fake_event.c +++ b/testcode/fake_event.c @@ -228,7 +228,7 @@ pending_find_match(struct replay_runtime* runtime, struct entry** entry, * @param runtime: runtime. * @param entry: if true, the entry that matches is returned. * @param pend: if true, the outgoing message that matches is returned. - * return: true if pending query matches the now event. + * @return: true if pending query matches the now event. */ static int pending_matches_range(struct replay_runtime* runtime, diff --git a/testcode/ldns-testpkts.c b/testcode/ldns-testpkts.c index 32bfba501..22d30b173 100644 --- a/testcode/ldns-testpkts.c +++ b/testcode/ldns-testpkts.c @@ -258,8 +258,7 @@ static struct entry* new_entry() * @param buf: is the buffer to store the result in * @param offset: is the starting position in the result buffer * @param buf_len: is the length of buf. - * - * This function returns the length of the result + * @return This function returns the length of the result */ static size_t hexstr2bin(char *hexstr, int len, uint8_t *buf, size_t offset, size_t buf_len) diff --git a/testcode/testbound.c b/testcode/testbound.c index 0f12c7996..5d16d55e8 100644 --- a/testcode/testbound.c +++ b/testcode/testbound.c @@ -251,6 +251,7 @@ void remove_configfile(void) * Main fake event test program. Setup, teardown and report errors. * @param argc: arg count. * @param argv: array of commandline arguments. + * @return program failure if test fails. */ int main(int argc, char* argv[]) diff --git a/testcode/unitmain.c b/testcode/unitmain.c index c0985106c..e9e28c53c 100644 --- a/testcode/unitmain.c +++ b/testcode/unitmain.c @@ -487,6 +487,7 @@ void unit_show_feature(const char* feature) * Main unit test program. Setup, teardown and report errors. * @param argc: arg count. * @param argv: array of commandline arguments. + * @return program failure if test fails. */ int main(int argc, char* argv[]) diff --git a/util/data/dname.h b/util/data/dname.h index 0a7803c18..b942848a9 100644 --- a/util/data/dname.h +++ b/util/data/dname.h @@ -257,6 +257,7 @@ void dname_remove_labels(uint8_t** dname, size_t* len, int n); * Count labels for the RRSIG signature label field. * Like a normal labelcount, but "*" wildcard and "." root are not counted. * @param dname: valid uncompressed wireformat. + * @return number of labels like in RRSIG; '*' and '.' are not counted. */ int dname_signame_label_count(uint8_t* dname); diff --git a/util/net_help.h b/util/net_help.h index 8afa84b26..b0d2ed499 100644 --- a/util/net_help.h +++ b/util/net_help.h @@ -233,7 +233,7 @@ int sockaddr_cmp_addr(struct sockaddr_storage* addr1, socklen_t len1, * Checkout address family. * @param addr: the sockaddr to examine. * @param len: the length of addr. - * return: true if sockaddr is ip6. + * @return: true if sockaddr is ip6. */ int addr_is_ip6(struct sockaddr_storage* addr, socklen_t len); @@ -272,7 +272,7 @@ void addr_to_str(struct sockaddr_storage* addr, socklen_t addrlen, char* buf, size_t len); /** - * See if sockaddr is an ipv6 mapped ipv4 address, ::ffff:0.0.0.0 + * See if sockaddr is an ipv6 mapped ipv4 address, "::ffff:0.0.0.0" * @param addr: address * @param addrlen: length of address * @return true if so diff --git a/validator/autotrust.h b/validator/autotrust.h index 61b6a9dc8..4e88ed320 100644 --- a/validator/autotrust.h +++ b/validator/autotrust.h @@ -141,6 +141,7 @@ void autr_global_delete(struct autr_global_data* global); /** * See if autotrust anchors are configured and how many. * @param anchors: the trust anchors structure. + * @return number of autotrust trust anchors */ size_t autr_get_num_anchors(struct val_anchors* anchors); diff --git a/validator/val_sigcrypt.c b/validator/val_sigcrypt.c index faddf5c43..25790f583 100644 --- a/validator/val_sigcrypt.c +++ b/validator/val_sigcrypt.c @@ -155,6 +155,7 @@ dnskey_get_flags(struct ub_packed_rrset_key* k, size_t idx) * Get DNSKEY protocol value from rdata * @param k: DNSKEY rrset. * @param idx: which key. + * @return protocol octet value */ static int dnskey_get_protocol(struct ub_packed_rrset_key* k, size_t idx)