Browse Source

Fix all doxygen warnings (other than missing docs)

Nick Mathewson 8 years ago
parent
commit
dd572dac34
5 changed files with 9 additions and 8 deletions
  1. 1 1
      src/common/crypto_ed25519.c
  2. 4 4
      src/or/dircollate.c
  3. 1 1
      src/or/main.c
  4. 2 1
      src/or/microdesc.c
  5. 1 1
      src/or/torcert.c

+ 1 - 1
src/common/crypto_ed25519.c

@@ -414,7 +414,7 @@ ed25519_seckey_write_to_file(const ed25519_secret_key_t *seckey,
 
 /**
  * Read seckey unencrypted from <b>filename</b>, storing it into
- * <b>seckey_out</b>.  Set *<b>tag_out</> to the tag it was marked with.
+ * <b>seckey_out</b>.  Set *<b>tag_out</b> to the tag it was marked with.
  * Return 0 on success, -1 on failure.
  */
 int

+ 4 - 4
src/or/dircollate.c

@@ -225,12 +225,12 @@ dircollator_collate_by_rsa(dircollator_t *dc)
  * entry in <b>dc</b> by ed25519 key and by RSA key.
  *
  * The rule is, approximately:
- *    If a <ed,rsa> identity is listed by more than half of authorities,
- *    include it.  And include all <rsa>-only votes about that node as
+ *    If a (ed,rsa) identity is listed by more than half of authorities,
+ *    include it.  And include all (rsa)-only votes about that node as
  *    matching.
  *
- *    Otherwise, if an <*,rsa> or <rsa> identity is listed by more than
- *    half of the authorities, and no <ed,rsa> pair for the same RSA key
+ *    Otherwise, if an (*,rsa) or (rsa) identity is listed by more than
+ *    half of the authorities, and no (ed,rsa) pair for the same RSA key
  *    has been already been included based on the rule above, include
  *    that RSA identity.
  */

+ 1 - 1
src/or/main.c

@@ -544,7 +544,7 @@ connection_is_reading(connection_t *conn)
 }
 
 /** Check whether <b>conn</b> is correct in having (or not having) a
- * read/write event (passed in <b>ev</b). On success, return 0. On failure,
+ * read/write event (passed in <b>ev</b>). On success, return 0. On failure,
  * log a warning and return -1. */
 static int
 connection_check_event(connection_t *conn, struct event *ev)

+ 2 - 1
src/or/microdesc.c

@@ -60,7 +60,8 @@ microdesc_hash_(microdesc_t *md)
   return (unsigned) siphash24g(md->digest, sizeof(md->digest));
 }
 
-/** Helper: compares <b>a</b> and </b> for equality for hash-table purposes. */
+/** Helper: compares <b>a</b> and <b>b</b> for equality for hash-table
+ * purposes. */
 static inline int
 microdesc_eq_(microdesc_t *a, microdesc_t *b)
 {

+ 1 - 1
src/or/torcert.c

@@ -107,7 +107,7 @@ tor_cert_create(const ed25519_keypair_t *signing_key,
                             now, lifetime, flags);
 }
 
-/** Release all storage held for <b>cert</>. */
+/** Release all storage held for <b>cert</b>. */
 void
 tor_cert_free(tor_cert_t *cert)
 {