summaryrefslogtreecommitdiff
path: root/src/app
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-08-26 19:33:55 -0400
committerNick Mathewson <nickm@torproject.org>2019-08-28 09:42:17 -0400
commit06da2c0d28e41c5a230d96ae8e4f72471bccb5d3 (patch)
tree7692aabe454cb4a6b9db90e44327ee650759de10 /src/app
parent3af1cee6d91a03912ffa0ddb866b5a85683cf178 (diff)
downloadtor-06da2c0d28e41c5a230d96ae8e4f72471bccb5d3.tar.gz
tor-06da2c0d28e41c5a230d96ae8e4f72471bccb5d3.zip
Document or_state_t.substates_
Diffstat (limited to 'src/app')
-rw-r--r--src/app/config/or_state_st.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/app/config/or_state_st.h b/src/app/config/or_state_st.h
index 54390fa2d2..225003bb7e 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_;
};