[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[or-cvs] r17727: {tor} Fix all of the doxygen warnings not pertaining to missing do (in tor/trunk/src: common or)

To: or-cvs@xxxxxxxxxxxxx
Subject: [or-cvs] r17727: {tor} Fix all of the doxygen warnings not pertaining to missing do (in tor/trunk/src: common or)
From: nickm@xxxxxxxx
Date: Mon, 22 Dec 2008 09:56:16 -0500 (EST)
Delivered-to: archiver@xxxxxxxx
Delivered-to: or-cvs-outgoing@xxxxxxxx
Delivered-to: or-cvs@xxxxxxxx
Delivery-date: Mon, 22 Dec 2008 09:56:19 -0500
Reply-to: or-dev@xxxxxxxxxxxxx
Sender: owner-or-cvs@xxxxxxxxxxxxx
Author: nickm
Date: 2008-12-22 09:56:16 -0500 (Mon, 22 Dec 2008)
New Revision: 17727

Modified:
   tor/trunk/src/common/address.c
   tor/trunk/src/common/util.c
   tor/trunk/src/or/circuitbuild.c
   tor/trunk/src/or/circuituse.c
   tor/trunk/src/or/control.c
   tor/trunk/src/or/directory.c
   tor/trunk/src/or/dirserv.c
   tor/trunk/src/or/dirvote.c
   tor/trunk/src/or/relay.c
   tor/trunk/src/or/routerlist.c
   tor/trunk/src/or/test.c
Log:
Fix all of the doxygen warnings not pertaining to missing documentation.

Modified: tor/trunk/src/common/address.c
===================================================================
--- tor/trunk/src/common/address.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/common/address.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -1012,7 +1012,7 @@
 }
 
 /** 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)

Modified: tor/trunk/src/common/util.c
===================================================================
--- tor/trunk/src/common/util.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/common/util.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -249,7 +249,7 @@
 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 *

Modified: tor/trunk/src/or/circuitbuild.c
===================================================================
--- tor/trunk/src/or/circuitbuild.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/circuitbuild.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -2908,7 +2908,7 @@
   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? */

Modified: tor/trunk/src/or/circuituse.c
===================================================================
--- tor/trunk/src/or/circuituse.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/circuituse.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -233,7 +233,7 @@
 }
 
 /** 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,

Modified: tor/trunk/src/or/control.c
===================================================================
--- tor/trunk/src/or/control.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/control.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -377,7 +377,7 @@
   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 @@
  * 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 @@
  * 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 @@
   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.

Modified: tor/trunk/src/or/directory.c
===================================================================
--- tor/trunk/src/or/directory.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/directory.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -2314,7 +2314,7 @@
  * 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 @@
 
 /** 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,

Modified: tor/trunk/src/or/dirserv.c
===================================================================
--- tor/trunk/src/or/dirserv.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/dirserv.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -1870,7 +1870,7 @@
  * 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

Modified: tor/trunk/src/or/dirvote.c
===================================================================
--- tor/trunk/src/or/dirvote.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/dirvote.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -1157,7 +1157,7 @@
 /** 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

Modified: tor/trunk/src/or/relay.c
===================================================================
--- tor/trunk/src/or/relay.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/relay.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -1804,7 +1804,7 @@
   }
 }
 
-/** 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]

Modified: tor/trunk/src/or/routerlist.c
===================================================================
--- tor/trunk/src/or/routerlist.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/routerlist.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -337,7 +337,7 @@
 }
 
 /** 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 @@
 }
 
 /** 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)

Modified: tor/trunk/src/or/test.c
===================================================================
--- tor/trunk/src/or/test.c	2008-12-22 09:52:56 UTC (rev 17726)
+++ tor/trunk/src/or/test.c	2008-12-22 14:56:16 UTC (rev 17727)
@@ -1354,7 +1354,7 @@
     _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_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 @@
   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) \
Prev by Author: [or-cvs] r17722: {tor} Yet still more propagating of things that need to be was_rou (tor/trunk/src/or)
Next by Author: [or-cvs] r17728: {} Add a script to post-process doxygen output into a sensible (tor/trunk/contrib)
Previous by thread: [or-cvs] r17726: {tor} fix typo noticed by wood (tor/trunk/src/or)
Next by thread: [or-cvs] r17728: {} Add a script to post-process doxygen output into a sensible (tor/trunk/contrib)
Index(es):
- Author
- Thread