doxygeny goodness from tyranix

svn:r4262

src/or/command.c

@@ -25,7 +25,7 @@ unsigned long stats_n_created_cells_processed = 0;
 unsigned long stats_n_relay_cells_processed = 0;
 unsigned long stats_n_destroy_cells_processed = 0;
 
-/** These are the main four functions for processing cells */
+/* These are the main four functions for processing cells */
 static void command_process_create_cell(cell_t *cell, connection_t *conn);
 static void command_process_created_cell(cell_t *cell, connection_t *conn);
 static void command_process_relay_cell(cell_t *cell, connection_t *conn);

src/or/config.c

@@ -1919,7 +1919,7 @@ config_register_addressmaps(or_options_t *options) {
 
 /** If <b>range</b> is of the form MIN-MAX, for MIN and MAX both
  * recognized log severity levels, set *<b>min_out</b> to MIN and
- * *<b>max_out</b> to MAX and return 0.  Else, if <b>range<b> is of
+ * *<b>max_out</b> to MAX and return 0.  Else, if <b>range</b> is of
  * the form MIN, act as if MIN-err had been specified.  Else, warn and
  * return -1.
  */
@@ -2084,7 +2084,7 @@ config_init_logs(or_options_t *options, int validate_only)
   return ok?0:-1;
 }
 
-/** Add a single option of the form Log min-max <type> [fname] to options. */
+/** Add a single option of the form Log min-max \<type\> [fname] to options. */
 static int
 add_single_log_option(or_options_t *options, int minSeverity, int maxSeverity,
                       const char *type, const char *fname)

src/or/connection.c

@@ -652,7 +652,7 @@ static int connection_init_accepted_conn(connection_t *conn) {
 
 /** Take conn, make a nonblocking socket; try to connect to
  * addr:port (they arrive in *host order*). If fail, return -1. Else
- * assign s to conn->\s: if connected return 1, if EAGAIN return 0.
+ * assign s to conn-\>s: if connected return 1, if EAGAIN return 0.
  *
  * address is used to make the logs useful.
  *
@@ -960,7 +960,7 @@ static int connection_receiver_bucket_should_increase(connection_t *conn) {
   return 1;
 }
 
-/** Read bytes from conn->\s and process them.
+/** Read bytes from conn-\>s and process them.
  *
  * This function gets called from conn_read() in main.c, either
  * when poll() has declared that conn wants to read, or (for OR conns)

src/or/connection_edge.c

@@ -1680,10 +1680,10 @@ set_exit_redirects(smartlist_t *lst)
 }
 
 /** If address is of the form "y.onion" with a well-formed handle y:
- *     Put a '\0' after y, lower-case it, and return ONION_HOSTNAME.
+ *     Put a \code{'\0'} after y, lower-case it, and return ONION_HOSTNAME.
  *
  * If address is of the form "y.exit":
- *     Put a '\0' after y and return EXIT_HOSTNAME.
+ *     Put a \code{'\0'} after y and return EXIT_HOSTNAME.
  *
  * Otherwise:
  *     Return NORMAL_HOSTNAME and change nothing.

src/or/directory.c

@@ -439,7 +439,9 @@ directory_send_command(connection_t *conn, const char *platform,
 }
 
 /** Parse an HTTP request string <b>headers</b> of the form
+ * \verbatim
  * "\%s [http[s]://]\%s HTTP/1..."
+ * \endverbatim
  * If it's well-formed, strdup the second \%s into *<b>url</b>, and
  * null-terminate it. If the url doesn't start with "/tor/", rewrite it
  * so it does. Return 0.
@@ -485,7 +487,9 @@ parse_http_url(char *headers, char **url)
 }
 
 /** Parse an HTTP response string <b>headers</b> of the form
+ * \verbatim
  * "HTTP/1.\%d \%d\%s\r\n...".
+ * \endverbatim
  *
  * If it's well-formed, assign the status code to *<b>code</b> and
  * return 0.  Otherwise, return -1.

src/or/router.c

@@ -15,7 +15,7 @@ const char router_c_id[] = "$Id$";
 
 extern long stats_n_seconds_working;
 
-/** Exposed for test.c. */ void get_platform_str(char *platform, size_t len);
+/* Exposed for test.c. */ void get_platform_str(char *platform, size_t len);
 
 /************************************************************/
 

src/or/routerlist.c

@@ -247,7 +247,7 @@ static void mark_all_trusteddirservers_up(void) {
   }
 }
 
-/** Return 0 if \exists an authoritative dirserver that's currently
+/** Return 0 if \\exists an authoritative dirserver that's currently
  * thought to be running, else return 1.
  */
 int all_trusted_directory_servers_down(void) {

src/or/routerparse.c

@@ -701,7 +701,7 @@ static int dir_signing_key_is_trusted(crypto_pk_env_t *key)
  * Otherwise, if pkey is provided, try to use it.
  *
  * (New callers should always use <b>declared_key</b> when possible;
- * <b>pkey is only for debugging.)
+ * <b>pkey</b> is only for debugging.)
  */
 static int check_directory_signature(const char *digest,
                                      directory_token_t *tok,