diff options
Diffstat (limited to 'src/or/rendcommon.c')
| -rw-r--r-- | src/or/rendcommon.c | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/src/or/rendcommon.c b/src/or/rendcommon.c index a2dda01ae8..b96557d494 100644 --- a/src/or/rendcommon.c +++ b/src/or/rendcommon.c @@ -10,7 +10,7 @@ #include "or.h" -/** Free the storage held by the service descriptor 'desc'. +/** Free the storage held by the service descriptor <b>desc</b>. */ void rend_service_descriptor_free(rend_service_descriptor_t *desc) { @@ -26,8 +26,9 @@ void rend_service_descriptor_free(rend_service_descriptor_t *desc) tor_free(desc); } -/** Encode a service descriptor for 'desc', and sign it with 'key'. Store - * the descriptor in *str_out, and set *len_out to its length. +/** Encode a service descriptor for <b>desc</b>, and sign it with + * <b>key</b>. Store the descriptor in *<b>str_out</b>, and set + * *<b>len_out</b> to its length. */ int rend_encode_service_descriptor(rend_service_descriptor_t *desc, @@ -72,9 +73,9 @@ rend_encode_service_descriptor(rend_service_descriptor_t *desc, return 0; } -/** Parse a service descriptor at 'str' (len bytes). On success, - * return a newly alloced service_descriptor_t. On failure, return - * NULL. +/** Parse a service descriptor at <b>str</b> (<b>len</b> bytes). On + * success, return a newly alloced service_descriptor_t. On failure, + * return NULL. */ rend_service_descriptor_t *rend_parse_service_descriptor( const char *str, int len) @@ -129,9 +130,9 @@ rend_service_descriptor_t *rend_parse_service_descriptor( return NULL; } -/** Sets out to the first 10 bytes of the digest of 'pk', base32 - * encoded. NUL-terminates out. (We use this string to identify - * services in directory requests and .onion URLs.) +/** Sets <b>out</b> to the first 10 bytes of the digest of <b>pk</b>, + * base32 encoded. NUL-terminates out. (We use this string to + * identify services in directory requests and .onion URLs.) */ int rend_get_service_id(crypto_pk_env_t *pk, char *out) { @@ -184,7 +185,7 @@ void rend_cache_clean(void) } } -/** Return true iff 'query' is a syntactically valid service ID (as +/** Return true iff <b>query</b> is a syntactically valid service ID (as * generated by rend_get_service_id). */ int rend_valid_service_id(const char *query) { if(strlen(query) != REND_SERVICE_ID_LEN) @@ -196,8 +197,8 @@ int rend_valid_service_id(const char *query) { return 1; } -/** If we have a cached rend_cache_entry_t for the service ID 'query', set - * *e to that entry and return 1. Else return 0. +/** If we have a cached rend_cache_entry_t for the service ID <b>query</b>, set + * *<b>e</b> to that entry and return 1. Else return 0. */ int rend_cache_lookup_entry(const char *query, rend_cache_entry_t **e) { @@ -210,11 +211,11 @@ int rend_cache_lookup_entry(const char *query, rend_cache_entry_t **e) return 1; } -/** 'query' is a base-32'ed service id. If it's malformed, return -1. +/** <b>query</b> is a base-32'ed service id. If it's malformed, return -1. * Else look it up. - * If it is found, point *desc to it, and write its length into - * *desc_len, and return 1. - * If it is not found, return 0. + * - If it is found, point *desc to it, and write its length into + * *desc_len, and return 1. + * - If it is not found, return 0. * Note: calls to rend_cache_clean or rend_cache_store may invalidate * *desc. */ @@ -292,7 +293,7 @@ int rend_cache_store(const char *desc, int desc_len) } /** Called when we get a rendezvous-related relay cell on circuit - * *circ. Dispatch on rendezvous relay command. */ + * <b>circ</b>. Dispatch on rendezvous relay command. */ void rend_process_relay_cell(circuit_t *circ, int command, int length, const char *payload) { |