[tor-commits] [tor/master] Document or_state_t.substates_

[dgoulet at torproject.org]

commit 06da2c0d28e41c5a230d96ae8e4f72471bccb5d3
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Aug 26 19:33:55 2019 -0400

    Document or_state_t.substates_
---
 src/app/config/or_state_st.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/app/config/or_state_st.h b/src/app/config/or_state_st.h
index 54390fa2d..225003bb7 100644
--- a/src/app/config/or_state_st.h
+++ b/src/app/config/or_state_st.h
@@ -96,7 +96,12 @@ struct or_state_t {
    * weren't.  "auto" on initial startup. */
   int Dormant;
 
-  /**DOCDOC*/
+  /**
+   * State objects for individual modules.
+   *
+   * Never access this field or its members directly: instead, use the module
+   * in question to get its relevant state object if you must.
+   */
   struct config_suite_t *substates_;
 };