tor

commit ef106ce7884b0af7adcf9f3965ebbe843a47912c
parent 4f42c923d61655235ebbae82f64106ecff9458d7
Author: Nick Mathewson <nickm@torproject.org>
Date:   Tue, 10 Jul 2018 12:28:22 -0400

Document the headers in src/app/config/

Diffstat:
M
src/app/config/confparse.h
 | 
6
++++++
M
src/app/config/or_options_st.h
 | 
6
++++++
M
src/app/config/or_state_st.h
 | 
6
++++++
M
src/app/config/statefile.h
 | 
6
++++++

4 files changed, 24 insertions(+), 0 deletions(-)
diff --git 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
@@ -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
@@ -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
@@ -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