From 55348884b5fddb0fb8ebdf45fc6aac4e59b8a212 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Mon, 22 Dec 2008 14:56:16 +0000 Subject: [PATCH] Fix all of the doxygen warnings not pertaining to missing documentation. svn:r17727 --- src/common/address.c | 2 +- src/common/util.c | 2 +- src/or/circuitbuild.c | 2 +- src/or/circuituse.c | 2 +- src/or/control.c | 8 ++++---- src/or/directory.c | 4 ++-- src/or/dirserv.c | 2 +- src/or/dirvote.c | 2 +- src/or/relay.c | 2 +- src/or/routerlist.c | 4 ++-- src/or/test.c | 6 +++--- 11 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/common/address.c b/src/common/address.c index efbc79c2be..df4c3f5701 100644 --- a/src/common/address.c +++ b/src/common/address.c @@ -1012,7 +1012,7 @@ tor_addr_from_str(tor_addr_t *addr, const char *src) } /** Parse an address or address-port combination from s, and put the - result in addr_outport_out. Return 0 on + result in addr_out and (optionally) port_out. Return 0 on success, negative on failure.*/ int tor_addr_port_parse(const char *s, tor_addr_t *addr_out, uint16_t *port_out) diff --git a/src/common/util.c b/src/common/util.c index ec2b1c9767..659766a4ed 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -249,7 +249,7 @@ _tor_free(void *mem) extern size_t malloc_good_size(size_t size); #endif -/** Allocate and return a chunk of memory of size at least *size

, using +/** Allocate and return a chunk of memory of size at least *size, using * the same resources we would use to malloc *sizep. Set *sizep * to the number of usable bytes in the chunk of memory. */ void * diff --git a/src/or/circuitbuild.c b/src/or/circuitbuild.c index d5ec19361a..8129437554 100644 --- a/src/or/circuitbuild.c +++ b/src/or/circuitbuild.c @@ -2908,7 +2908,7 @@ typedef struct { tor_addr_t addr; /** TLS port for the bridge. */ uint16_t port; - /** Expected identity digest, or all \0's if we don't know what the + /** Expected identity digest, or all zero bytes if we don't know what the * digest should be. */ char identity[DIGEST_LEN]; /** When should we next try to fetch a descriptor for this bridge? */ diff --git a/src/or/circuituse.c b/src/or/circuituse.c index c6d8cde3c8..6b7bf7409d 100644 --- a/src/or/circuituse.c +++ b/src/or/circuituse.c @@ -233,7 +233,7 @@ circuit_get_best(edge_connection_t *conn, int must_be_open, uint8_t purpose, } /** Check whether, according to the policies in options, the - * circuit circ makes sense. */ + * circuit circ makes sense. */ /* XXXX currently only checks Exclude{Exit}Nodes. It should check more. */ int circuit_conforms_to_options(const origin_circuit_t *circ, diff --git a/src/or/control.c b/src/or/control.c index 03f337c61e..0ba2588e9b 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -377,7 +377,7 @@ read_escaped_data(const char *data, size_t len, char **out) return outp - *out; } -/** If the first in_len_max characters in start contain a +/** If the first in_len_max characters in start contain a * double-quoted string with escaped characters, return the length of that * string (as encoded, including quotes). Otherwise return -1. */ static INLINE int @@ -470,7 +470,7 @@ decode_escaped_string(const char *start, size_t in_len_max, * but it will always end with a CRLF sequence. * * Currently the length of the message is limited to 1024 (including the - * ending \r\n\0. */ + * ending CR LF NUL ("\\r\\n\\0") . */ static void connection_printf_to_buf(control_connection_t *conn, const char *format, ...) { @@ -567,7 +567,7 @@ send_control_event_string(uint16_t event, event_format_t which, * sent only to controllers that have enabled extended events. * * Currently the length of the message is limited to 1024 (including the - * ending \n\r\0). */ + * ending \\r\\n\\0). */ static void send_control_event_impl(uint16_t event, event_format_t which, int extended, const char *format, va_list ap) @@ -3421,7 +3421,7 @@ control_event_descriptors_changed(smartlist_t *routers) return 0; } -/** Called whenever an address mapping on from from changes to to. +/** Called when an address mapping on from from changes to to. * expires values less than 3 are special; see connection_edge.c. If * error is non-NULL, it is an error code describing the failure * mode of the mapping. diff --git a/src/or/directory.c b/src/or/directory.c index 7d83171f75..a5590fae3e 100644 --- a/src/or/directory.c +++ b/src/or/directory.c @@ -2314,7 +2314,7 @@ directory_dump_request_log(void) * than half the authorities in a list. They pass this list in * the url as "...consensus/fpr+fpr+fpr". * - * fpr may be an abbreviated fingerprint, i.e. only a left substring + * fpr may be an abbreviated fingerprint, i.e. only a left substring * of the full authority identity digest. (Only strings of even length, * i.e. encodings of full bytes, are handled correctly. In the case * of an odd number of hex digits the last one is silently ignored.) @@ -3278,7 +3278,7 @@ static const int client_consensus_dl_schedule[] = { /** Called when an attempt to download dls has failed with HTTP status * status_code. Increment the failure count (if the code indicates a - * real failure) and set dls->next_attempt_at to an appropriate time in + * real failure) and set dls->next_attempt_at to an appropriate time in * the future. */ time_t download_status_increment_failure(download_status_t *dls, int status_code, diff --git a/src/or/dirserv.c b/src/or/dirserv.c index 598316fcda..8694da702f 100644 --- a/src/or/dirserv.c +++ b/src/or/dirserv.c @@ -1870,7 +1870,7 @@ version_from_platform(const char *platform) * which has at least buf_len free characters. Do NUL-termination. * Use the same format as in network-status documents. If version is * non-NULL, add a "v" line for the platform. Return 0 on success, -1 on - * failure. If first_line_only is true, don't include any flags + * failure. If first_line_only is true, don't include any flags * or version line. */ int diff --git a/src/or/dirvote.c b/src/or/dirvote.c index 8fe53c7953..a245b36e7a 100644 --- a/src/or/dirvote.c +++ b/src/or/dirvote.c @@ -1157,7 +1157,7 @@ networkstatus_compute_consensus(smartlist_t *votes, /** Given a consensus vote target and a set of detached signatures in * sigs that correspond to the same consensus, check whether there are * any new signatures in src_voter_list that should be added to - * target. (A signature should be added if we have no signature for that + * target. (A signature should be added if we have no signature for that * voter in target yet, or if we have no verifiable signature and the * new signature is verifiable.) Return the number of signatures added or * changed, or -1 if the document signed by sigs isn't the same diff --git a/src/or/relay.c b/src/or/relay.c index 350bf802f1..6060da0b81 100644 --- a/src/or/relay.c +++ b/src/or/relay.c @@ -1804,7 +1804,7 @@ append_cell_to_circuit_queue(circuit_t *circ, or_connection_t *orconn, } } -/** Append an encoded value of addr to payload_out, which must +/** Append an encoded value of addr to payload_out, which must * have at least 18 bytes of free space. The encoding is, as specified in * tor-spec.txt: * RESOLVED_TYPE_IPV4 or RESOLVED_TYPE_IPV6 [1 byte] diff --git a/src/or/routerlist.c b/src/or/routerlist.c index 006713f017..427356422f 100644 --- a/src/or/routerlist.c +++ b/src/or/routerlist.c @@ -337,7 +337,7 @@ authority_cert_get_newest_by_id(const char *id_digest) } /** Return the newest v3 authority certificate whose directory signing key has - * giest . Return NULL if no such certificate is known. + * digest sk_digest. Return NULL if no such certificate is known. */ authority_cert_t * authority_cert_get_by_sk_digest(const char *sk_digest) @@ -2657,7 +2657,7 @@ routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int make_old) } /** Remove a signed_descriptor_t sd from rl-\>old_routers, and - * adjust rl as appropriate. idx is -1, or the index of + * adjust rl as appropriate. idx is -1, or the index of * sd. */ static void routerlist_remove_old(routerlist_t *rl, signed_descriptor_t *sd, int idx) diff --git a/src/or/test.c b/src/or/test.c index 28bf46f952..54d7439f2c 100644 --- a/src/or/test.c +++ b/src/or/test.c @@ -1354,7 +1354,7 @@ _test_eq_ip6(struct in6_addr *a, struct in6_addr *b, const char *e1, _test_eq_ip6(&a1, &a2, a, b, __LINE__); \ STMT_END -/** Helper: assert that a parses by tor_inet_pton() into a address that +/** Helper: assert that a parses by tor_inet_pton() into a address that * passes tor_addr_is_internal() with for_listening */ #define test_internal_ip(a,for_listening) STMT_BEGIN \ test_eq(tor_inet_pton(AF_INET6, a, &t1.addr.in6_addr), 1); \ @@ -1363,7 +1363,7 @@ _test_eq_ip6(struct in6_addr *a, struct in6_addr *b, const char *e1, test_fail_msg( a "was not internal."); \ STMT_END -/** Helper: assert that a parses by tor_inet_pton() into a address that +/** Helper: assert that a parses by tor_inet_pton() into a address that * does not pass tor_addr_is_internal() with for_listening. */ #define test_external_ip(a,for_listening) STMT_BEGIN \ test_eq(tor_inet_pton(AF_INET6, a, &t1.addr.in6_addr), 1); \ @@ -1397,7 +1397,7 @@ _test_eq_ip6(struct in6_addr *a, struct in6_addr *b, const char *e1, STMT_END /** Helper: assert that xx is parseable as a masked IPv6 address with - * ports by tor_parse_mask_addr_ports(), with family f, IP address + * ports by tor_parse_mask_addr_ports(), with family f, IP address * as 4 32-bit words ip1...ip4, mask bits as mm, and port range * as pt1..pt2. */ #define test_addr_mask_ports_parse(xx, f, ip1, ip2, ip3, ip4, mm, pt1, pt2) \