Browse Source

Document or_state_t.substates_

Nick Mathewson 6 years ago
parent
commit
06da2c0d28
1 changed files with 6 additions and 1 deletions
  1. 6 1
      src/app/config/or_state_st.h

+ 6 - 1
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_;
 };