commit ef106ce7884b0af7adcf9f3965ebbe843a47912c Author: Nick Mathewson nickm@torproject.org Date: Tue Jul 10 12:28:22 2018 -0400
Document the headers in src/app/config/ --- src/app/config/confparse.h | 6 ++++++ src/app/config/or_options_st.h | 6 ++++++ src/app/config/or_state_st.h | 6 ++++++ src/app/config/statefile.h | 6 ++++++ 4 files changed, 24 insertions(+)
diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h index cbd2ea88e..570428c90 100644 --- a/src/app/config/confparse.h +++ b/src/app/config/confparse.h @@ -4,6 +4,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */
+/** + * \file confparse.h + * + * \brief Header for confparse.c. + */ + #ifndef TOR_CONFPARSE_H #define TOR_CONFPARSE_H
diff --git a/src/app/config/or_options_st.h b/src/app/config/or_options_st.h index 0c0c5d32b..627b39aea 100644 --- a/src/app/config/or_options_st.h +++ b/src/app/config/or_options_st.h @@ -4,6 +4,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */
+/** + * \file or_options_st.h + * + * \brief The or_options_t structure, which represents Tor's configuration. + */ + #ifndef TOR_OR_OPTIONS_ST_H #define TOR_OR_OPTIONS_ST_H
diff --git a/src/app/config/or_state_st.h b/src/app/config/or_state_st.h index f1d5f981f..d95df6236 100644 --- a/src/app/config/or_state_st.h +++ b/src/app/config/or_state_st.h @@ -4,6 +4,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */
+/** + * \file or_state_t + * + * \brief The or_state_t structure, which represents Tor's state file. + */ + #ifndef TOR_OR_STATE_ST_H #define TOR_OR_STATE_ST_H
diff --git a/src/app/config/statefile.h b/src/app/config/statefile.h index e996d5b6e..6433affa6 100644 --- a/src/app/config/statefile.h +++ b/src/app/config/statefile.h @@ -4,6 +4,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */
+/** + * \file statefile.h + * + * \brief Header for statefile.c + */ + #ifndef TOR_STATEFILE_H #define TOR_STATEFILE_H