commit 25bffccd718220bd5b378d1517d09669d6685db1 Author: Alexander Færøy <ahf@torproject.org> Date: Tue Jul 2 18:49:44 2019 +0200 Document enumeration values for `outbound_addr_t`. This patch adds doxygen documentation strings for each of the values in `outbound_addr_t`. See: https://bugs.torproject.org/5304 --- src/app/config/or_options_st.h | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/src/app/config/or_options_st.h b/src/app/config/or_options_st.h index 3b84e5e1f2..9520a1b736 100644 --- a/src/app/config/or_options_st.h +++ b/src/app/config/or_options_st.h @@ -25,9 +25,24 @@ struct routerset_t; /** Enumeration of outbound address configuration types: * Exit-only, OR-only, or both */ -typedef enum {OUTBOUND_ADDR_EXIT, OUTBOUND_ADDR_OR, - OUTBOUND_ADDR_EXIT_AND_OR, - OUTBOUND_ADDR_MAX} outbound_addr_t; +typedef enum { + /** Outbound IP address for Exit connections. Controlled by the + * `OutboundBindAddressExit` configuration entry in torrc. */ + OUTBOUND_ADDR_EXIT, + + /** Outbound IP address for OR connections. Controlled by the + * `OutboundBindAddressOR` configuration entry in torrc. */ + OUTBOUND_ADDR_OR, + + /** Outbound IP address for both Exit and OR connections. Controlled by the + * OutboundBindAddress configuration entry in torrc. This value is used as + * fallback if the more specific OUTBOUND_ADDR_EXIT and OUTBOUND_ADDR_OR is + * unset. */ + OUTBOUND_ADDR_EXIT_AND_OR, + + /** Max value for this enum. Must be the last element in this enum. */ + OUTBOUND_ADDR_MAX +} outbound_addr_t; /** Which protocol to use for TCPProxy. */ typedef enum {