aboutsummaryrefslogtreecommitdiff
path: root/src/app
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-07-10 12:28:22 -0400
committerNick Mathewson <nickm@torproject.org>2018-07-10 12:28:31 -0400
commitef106ce7884b0af7adcf9f3965ebbe843a47912c (patch)
tree2e93beea719e5180287aa7cae7abbeaea4f0ea60 /src/app
parent4f42c923d61655235ebbae82f64106ecff9458d7 (diff)
downloadtor-ef106ce7884b0af7adcf9f3965ebbe843a47912c.tar.gz
tor-ef106ce7884b0af7adcf9f3965ebbe843a47912c.zip
Document the headers in src/app/config/
Diffstat (limited to 'src/app')
-rw-r--r--src/app/config/confparse.h6
-rw-r--r--src/app/config/or_options_st.h6
-rw-r--r--src/app/config/or_state_st.h6
-rw-r--r--src/app/config/statefile.h6
4 files changed, 24 insertions, 0 deletions
diff --git a/src/app/config/confparse.h b/src/app/config/confparse.h
index cbd2ea88e2..570428c904 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 0c0c5d32bb..627b39aea3 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 f1d5f981f1..d95df6236b 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 e996d5b6e6..6433affa62 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