Commit 55348884 authored by Nick Mathewson's avatar Nick Mathewson 🌉
Browse files

Fix all of the doxygen warnings not pertaining to missing documentation.

svn:r17727
parent df897483
......@@ -1012,7 +1012,7 @@ tor_addr_from_str(tor_addr_t *addr, const char *src)
}
/** Parse an address or address-port combination from <b>s</b>, and put the
result in <b>addr_out</b? and (optionally) <b>port_out</b>. Return 0 on
result in <b>addr_out</b> and (optionally) <b>port_out</b>. Return 0 on
success, negative on failure.*/
int
tor_addr_port_parse(const char *s, tor_addr_t *addr_out, uint16_t *port_out)
......
......@@ -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 *<b>size</p>, using
/** Allocate and return a chunk of memory of size at least *<b>size</b>, using
* the same resources we would use to malloc *<b>sizep</b>. Set *<b>sizep</b>
* to the number of usable bytes in the chunk of memory. */
void *
......
......@@ -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? */
......
......@@ -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 <b>options</b>, the
* circuit <b>circ makes sense. */
* circuit <b>circ</b> makes sense. */
/* XXXX currently only checks Exclude{Exit}Nodes. It should check more. */
int
circuit_conforms_to_options(const origin_circuit_t *circ,
......
......@@ -377,7 +377,7 @@ read_escaped_data(const char *data, size_t len, char **out)
return outp - *out;
}
/** If the first <b>in_len_max</b> characters in <b>start<b> contain a
/** If the first <b>in_len_max</b> characters in <b>start</b> 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 <b>from<b> from changes to <b>to</b>.
/** Called when an address mapping on <b>from</b> from changes to <b>to</b>.
* <b>expires</b> values less than 3 are special; see connection_edge.c. If
* <b>error</b> is non-NULL, it is an error code describing the failure
* mode of the mapping.
......
......@@ -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/<b>fpr</b>+<b>fpr</b>+<b>fpr</b>".
*
* <b>fpr<b/> may be an abbreviated fingerprint, i.e. only a left substring
* <b>fpr</b> 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 <b>dls</b> has failed with HTTP status
* <b>status_code</b>. Increment the failure count (if the code indicates a
* real failure) and set <b>dls<b>->next_attempt_at to an appropriate time in
* real failure) and set <b>dls</b>->next_attempt_at to an appropriate time in
* the future. */
time_t
download_status_increment_failure(download_status_t *dls, int status_code,
......
......@@ -1870,7 +1870,7 @@ version_from_platform(const char *platform)
* which has at least <b>buf_len</b> free characters. Do NUL-termination.
* Use the same format as in network-status documents. If <b>version</b> is
* non-NULL, add a "v" line for the platform. Return 0 on success, -1 on
* failure. If <b>first_line_only<b> is true, don't include any flags
* failure. If <b>first_line_only</b> is true, don't include any flags
* or version line.
*/
int
......
......@@ -1157,7 +1157,7 @@ networkstatus_compute_consensus(smartlist_t *votes,
/** Given a consensus vote <b>target</b> and a set of detached signatures in
* <b>sigs</b> that correspond to the same consensus, check whether there are
* any new signatures in <b>src_voter_list</b> that should be added to
* <b>target. (A signature should be added if we have no signature for that
* <b>target</b>. (A signature should be added if we have no signature for that
* voter in <b>target</b> 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 <b>sigs</b> isn't the same
......
......@@ -1804,7 +1804,7 @@ append_cell_to_circuit_queue(circuit_t *circ, or_connection_t *orconn,
}
}
/** Append an encoded value of <b>addr<b> to <b>payload_out</b>, which must
/** Append an encoded value of <b>addr</b> to <b>payload_out</b>, 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]
......
......@@ -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 <sk_digest</b>. Return NULL if no such certificate is known.
* digest <b>sk_digest</b>. 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 <b>sd</b> from <b>rl</b>-\>old_routers, and
* adjust <b>rl</b> as appropriate. <b>idx</i> is -1, or the index of
* adjust <b>rl</b> as appropriate. <b>idx</b> is -1, or the index of
* <b>sd</b>. */
static void
routerlist_remove_old(routerlist_t *rl, signed_descriptor_t *sd, int idx)
......
......@@ -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 <b>a</a> parses by tor_inet_pton() into a address that
/** Helper: assert that <b>a</b> parses by tor_inet_pton() into a address that
* passes tor_addr_is_internal() with <b>for_listening</b> */
#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 <b>a</a> parses by tor_inet_pton() into a address that
/** Helper: assert that <b>a</b> parses by tor_inet_pton() into a address that
* does not pass tor_addr_is_internal() with <b>for_listening</b>. */
#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 <b>xx</b> is parseable as a masked IPv6 address with
* ports by <b>tor_parse_mask_addr_ports(), with family <b>f</b>, IP address
* ports by tor_parse_mask_addr_ports(), with family <b>f</b>, IP address
* as 4 32-bit words <b>ip1...ip4</b>, mask bits as <b>mm</b>, and port range
* as <b>pt1..pt2</b>. */
#define test_addr_mask_ports_parse(xx, f, ip1, ip2, ip3, ip4, mm, pt1, pt2) \
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment