Document the headers in src/app/config/

diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h
index cbd2ea88e2db6175e577f730ba15314649769b31..570428c904e357cebd66f642d1d197bc86103e9b 100644 (file)
--- 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 0c0c5d32bbbf3a5338365389791046e960f8e6dd..627b39aea3308db5122afb631d57864bec54b55b 100644 (file)
--- 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 f1d5f981f166766db306425fd126085ad91e6198..d95df6236bc0dfd62815306dbdaa17d1eb3cac9c 100644 (file)
--- 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 e996d5b6e63d97494099827f3c30e3beed7ec2d0..6433affa621e3ea2d850ce9fed30b450ddb03903 100644 (file)
--- 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