浏览代码

Document the headers in src/app/config/

Nick Mathewson 6 年之前
父节点
当前提交
ef106ce788
共有 4 个文件被更改,包括 24 次插入0 次删除
  1. 6 0
      src/app/config/confparse.h
  2. 6 0
      src/app/config/or_options_st.h
  3. 6 0
      src/app/config/or_state_st.h
  4. 6 0
      src/app/config/statefile.h

+ 6 - 0
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
 

+ 6 - 0
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
 

+ 6 - 0
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
 

+ 6 - 0
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