[or-cvs] doxygeny goodness from tyranix

Roger Dingledine arma at seul.org
Tue May 17 17:01:39 UTC 2005


Update of /home2/or/cvsroot/tor/src/or
In directory moria.mit.edu:/home2/arma/work/onion/cvs/tor/src/or

Modified Files:
	command.c config.c connection.c connection_edge.c directory.c 
	router.c routerlist.c routerparse.c 
Log Message:
doxygeny goodness from tyranix


Index: command.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/command.c,v
retrieving revision 1.87
retrieving revision 1.88
diff -u -d -r1.87 -r1.88
--- command.c	7 May 2005 05:55:06 -0000	1.87
+++ command.c	17 May 2005 17:01:36 -0000	1.88
@@ -25,7 +25,7 @@
 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);

Index: config.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/config.c,v
retrieving revision 1.349
retrieving revision 1.350
diff -u -d -r1.349 -r1.350
--- config.c	17 May 2005 01:55:53 -0000	1.349
+++ config.c	17 May 2005 17:01:36 -0000	1.350
@@ -1919,7 +1919,7 @@
 
 /** 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 @@
   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)

Index: connection.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/connection.c,v
retrieving revision 1.369
retrieving revision 1.370
diff -u -d -r1.369 -r1.370
--- connection.c	7 May 2005 05:55:06 -0000	1.369
+++ connection.c	17 May 2005 17:01:36 -0000	1.370
@@ -652,7 +652,7 @@
 
 /** 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 @@
   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)

Index: connection_edge.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/connection_edge.c,v
retrieving revision 1.326
retrieving revision 1.327
diff -u -d -r1.326 -r1.327
--- connection_edge.c	11 May 2005 04:14:17 -0000	1.326
+++ connection_edge.c	17 May 2005 17:01:36 -0000	1.327
@@ -1680,10 +1680,10 @@
 }
 
 /** 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.

Index: directory.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/directory.c,v
retrieving revision 1.226
retrieving revision 1.227
diff -u -d -r1.226 -r1.227
--- directory.c	3 May 2005 10:12:08 -0000	1.226
+++ directory.c	17 May 2005 17:01:36 -0000	1.227
@@ -439,7 +439,9 @@
 }
 
 /** 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 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.

Index: router.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/router.c,v
retrieving revision 1.173
retrieving revision 1.174
diff -u -d -r1.173 -r1.174
--- router.c	14 May 2005 00:13:17 -0000	1.173
+++ router.c	17 May 2005 17:01:36 -0000	1.174
@@ -15,7 +15,7 @@
 
 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);
 
 /************************************************************/
 

Index: routerlist.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/routerlist.c,v
retrieving revision 1.232
retrieving revision 1.233
diff -u -d -r1.232 -r1.233
--- routerlist.c	14 May 2005 05:01:41 -0000	1.232
+++ routerlist.c	17 May 2005 17:01:36 -0000	1.233
@@ -247,7 +247,7 @@
   }
 }
 
-/** 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) {

Index: routerparse.c
===================================================================
RCS file: /home2/or/cvsroot/tor/src/or/routerparse.c,v
retrieving revision 1.109
retrieving revision 1.110
diff -u -d -r1.109 -r1.110
--- routerparse.c	7 May 2005 05:55:06 -0000	1.109
+++ routerparse.c	17 May 2005 17:01:36 -0000	1.110
@@ -701,7 +701,7 @@
  * 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,



More information about the tor-commits mailing list