Browse Source

clean up some more comments

svn:r4499
Roger Dingledine 19 years ago
parent
commit
0ee665708a
1 changed files with 8 additions and 6 deletions
  1. 8 6
      src/tools/tor-resolve.c

+ 8 - 6
src/tools/tor-resolve.c

@@ -44,9 +44,9 @@
   do { log_fn(LOG_ERR, "Error while %s: %s", act,           \
               tor_socket_strerror(tor_socket_errno(_s))); } while (0)
 
-/** Set *out to a newly allocated SOCKS4a resolve request with
- * username and hostname as provided.  Return the number of bytes in
- * the request. */
+/** Set *<b>out</b> to a newly allocated SOCKS4a resolve request with
+ * <b>username</b> and <b>hostname</b> as provided.  Return the number
+ * of bytes in the request. */
 static int
 build_socks4a_resolve_request(char **out,
                               const char *username,
@@ -69,8 +69,9 @@ build_socks4a_resolve_request(char **out,
   return len;
 }
 
-/** Given a len-byte SOCKS4a response in <b>response</b>, set *addr_out to the
- * address it contains (in host order).  Return 0 on success, -1 on error.
+/** Given a <b>len</b>-byte SOCKS4a response in <b>response</b>, set
+ * *<b>addr_out</b> to the address it contains (in host order).
+ * Return 0 on success, -1 on error.
  */
 static int
 parse_socks4a_resolve_response(const char *response, size_t len,
@@ -104,7 +105,7 @@ parse_socks4a_resolve_response(const char *response, size_t len,
 
 /** Send a resolve request for <b>hostname</b> to the Tor listening on
  * <b>sockshost</b>:<b>socksport</b>.  Store the resulting IPv4
- * address (in host order) into <b>result_addr</b>.
+ * address (in host order) into *<b>result_addr</b>.
  */
 static int
 do_resolve(const char *hostname, uint32_t sockshost, uint16_t socksport,
@@ -247,3 +248,4 @@ main(int argc, char **argv)
   printf("%s\n", buf);
   return 0;
 }
+