[tor-commits] [tor/master] Doxygen: Fix things that looked like links.

nickm at torproject.org nickm at torproject.org
Wed Oct 16 13:11:54 UTC 2019


commit f9fac733b900091917b56f6517ef2b2ed775f6e0
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Oct 16 08:44:35 2019 -0400

    Doxygen: Fix things that looked like links.
    
    Doxygen thinks that saying #foo is linking to a "foo" anchor
    someplace.
---
 src/core/or/circuitpadding.h |  2 +-
 src/lib/math/prob_distr.h    | 46 ++++++++++++++++++++++----------------------
 2 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/src/core/or/circuitpadding.h b/src/core/or/circuitpadding.h
index 683ac95de..a5c46b439 100644
--- a/src/core/or/circuitpadding.h
+++ b/src/core/or/circuitpadding.h
@@ -388,7 +388,7 @@ typedef struct circpad_state_t {
    *
    * States are allowed to transition to themselves, which means re-schedule
    * a new padding timer. They are also allowed to temporarily "transition"
-   * to the "IGNORE" and "CANCEL" pseudo-states. See #defines below
+   * to the "IGNORE" and "CANCEL" pseudo-states. See defines below
    * for details on state behavior and meaning.
    */
   circpad_statenum_t next_state[CIRCPAD_NUM_EVENTS];
diff --git a/src/lib/math/prob_distr.h b/src/lib/math/prob_distr.h
index 7254dc862..a93d88895 100644
--- a/src/lib/math/prob_distr.h
+++ b/src/lib/math/prob_distr.h
@@ -66,41 +66,41 @@ struct dist {
 * type-specific macro built out of it -- but if you did use this
 * directly, it would be something like:
 *
-*   struct weibull mydist = {
-*     DIST_BASE_TYPED(&weibull_ops, mydist, struct weibull),
-*     .lambda = ...,
-*     .k = ...,
-*   };
+*     struct weibull mydist = {
+*       DIST_BASE_TYPED(&weibull_ops, mydist, struct weibull),
+*       .lambda = ...,
+*       .k = ...,
+*     };
 *
 * If you want to define a distribution type, define a canonical set of
 * operations and define a type-specific initializer element like so:
 *
-*   struct foo {
-*     struct dist base;
-*     int omega;
-*     double tau;
-*     double phi;
-*   };
+*     struct foo {
+*       struct dist base;
+*       int omega;
+*       double tau;
+*       double phi;
+*     };
 *
-*   struct dist_ops foo_ops = ...;
+*     struct dist_ops foo_ops = ...;
 *
-*   #define FOO(OBJ) DIST_BASE_TYPED(&foo_ops, OBJ, struct foo)
+*     #define FOO(OBJ) DIST_BASE_TYPED(&foo_ops, OBJ, struct foo)
 *
 * Then users can do:
 *
-*   struct foo mydist = {
-*     FOO(mydist),
-*     .omega = ...,
-*     .tau = ...,
-*     .phi = ...,
-*   };
+*     struct foo mydist = {
+*       FOO(mydist),
+*       .omega = ...,
+*       .tau = ...,
+*       .phi = ...,
+*     };
 *
 * If you accidentally write
 *
-*   struct bar mydist = {
-*     FOO(mydist),
-*     ...
-*   };
+*     struct bar mydist = {
+*       FOO(mydist),
+*       ...
+*     };
 *
 * then the compiler will report a type mismatch in the sizeof
 * expression, which otherwise evaporates at runtime.



More information about the tor-commits mailing list