]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
doxygen: add @file declarations for src/app
authorNick Mathewson <nickm@torproject.org>
Sat, 26 Oct 2019 15:13:29 +0000 (11:13 -0400)
committerNick Mathewson <nickm@torproject.org>
Sat, 26 Oct 2019 15:41:43 +0000 (11:41 -0400)
If a file doesn't use the file command (either \file or @file),
Doxygen won't try to process it.

src/app/config/quiet_level.c
src/app/main/subsysmgr.c
src/app/main/subsysmgr.h
src/app/main/subsystem_list.c

index f00d6b5a3be9419f1d11bbed4f506602e365bd60..84bc0149b8d3f7284ea083be0abdf2c246420086 100644 (file)
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file quiet_level.c
+ * @brief Code to handle default logging level (quiet/hush/normal).
+ **/
+
 #include "orconfig.h"
 #include "lib/log/log.h"
 #include "app/config/quiet_level.h"
index 5aa4fd76c96b25000d94044268f77ec91e077222..1f4bc840f2d239362e16fa04a1616f19ca50385e 100644 (file)
@@ -3,6 +3,14 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file subsysmgr.c
+ * @brief Manager for Tor's subsystems.
+ *
+ * This code is responsible for initializing, configuring, and shutting
+ * down all of Tor's individual subsystems.
+ **/
+
 #include "orconfig.h"
 #include "app/main/subsysmgr.h"
 
index d4426614e386f752177b135d936ef1b5d108b578..f8bc83e0ad3817a13954f7ffdb88a0e4bedc525d 100644 (file)
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file subsysmgr.h
+ * @brief Header for subsysmgr.c
+ **/
+
 #ifndef TOR_SUBSYSMGR_T
 #define TOR_SUBSYSMGR_T
 
index 1af9340c1a71bf442b45b36490bce89386a63de1..4a40702e706bd214cbfc4feca2412dce7b6664d9 100644 (file)
@@ -3,6 +3,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file subsystem_list.c
+ * @brief List of Tor's subsystems.
+ **/
+
 #include "orconfig.h"
 #include "app/main/subsysmgr.h"
 #include "lib/cc/compat_compiler.h"