[tor-commits] [tor/master] Fix all doxygen warnings other than "X is not documented"

[nickm@xxxxxxxxxxxxxx]

commit 1f679d4ae11cd976f5539bc4ddf36873132aeb00
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Thu Feb 11 22:06:44 2016 -0500

    Fix all doxygen warnings other than "X is not documented"
---
 src/or/config.c      |  2 +-
 src/or/policies.c    | 14 ++++++++------
 src/or/routerparse.c |  2 +-
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/src/or/config.c b/src/or/config.c
index d71cf6d..5273d5a 100644
--- a/src/or/config.c
+++ b/src/or/config.c
@@ -2693,7 +2693,7 @@ options_validate_cb(void *old_options, void *options, void *default_options,
 
 /** Log a warning message iff <b>filepath</b> is not absolute.
  * Warning message must contain option name <b>option</b> and
- * an absolute path that <b>filepath<b> will resolve to.
+ * an absolute path that <b>filepath</b> will resolve to.
  *
  * In case <b>filepath</b> is absolute, do nothing.
  */
diff --git a/src/or/policies.c b/src/or/policies.c
index 984ab6a..179230b 100644
--- a/src/or/policies.c
+++ b/src/or/policies.c
@@ -1703,19 +1703,21 @@ exit_policy_remove_redundancies(smartlist_t *dest)
 /** Reject private helper for policies_parse_exit_policy_internal: rejects
  * publicly routable addresses on this exit relay.
  *
- * Add reject entries to the linked list *dest:
- *   - if configured_addresses is non-NULL, add entries that reject each
- *     tor_addr_t* in the list as a destination.
- *   - if reject_interface_addresses is true, add entries that reject each
+ * Add reject entries to the linked list *<b>dest</b>:
+ * <ul>
+ * <li>if configured_addresses is non-NULL, add entries that reject each
+ *     tor_addr_t in the list as a destination.
+ * <li>if reject_interface_addresses is true, add entries that reject each
  *     public IPv4 and IPv6 address of each interface on this machine.
- *   - if reject_configured_port_addresses is true, add entries that reject
+ * <li>if reject_configured_port_addresses is true, add entries that reject
  *     each IPv4 and IPv6 address configured for a port.
+ * </ul>
  *
  * IPv6 entries are only added if ipv6_exit is true. (All IPv6 addresses are
  * already blocked by policies_parse_exit_policy_internal if ipv6_exit is
  * false.)
  *
- * The list *dest is created as needed.
+ * The list in <b>dest</b> is created as needed.
  */
 void
 policies_parse_exit_policy_reject_private(
diff --git a/src/or/routerparse.c b/src/or/routerparse.c
index fafba96..3be43dc 100644
--- a/src/or/routerparse.c
+++ b/src/or/routerparse.c
@@ -3679,7 +3679,7 @@ networkstatus_parse_detached_signatures(const char *s, const char *eos)
  *
  * Returns NULL on policy errors.
  *
- * Set *<b>malformed_list>/b> to true if the entire policy list should be
+ * Set *<b>malformed_list</b> to true if the entire policy list should be
  * discarded. Otherwise, set it to false, and only this item should be ignored
  * on error - the rest of the policy list can continue to be processed and
  * used.

_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits