[tor-commits] [tor/master] doxygen: add @file declarations for src/app

[dgoulet@xxxxxxxxxxxxxx]

commit 30c6ab5150248019358addba391cd0a90e9614af
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Sat Oct 26 11:13:29 2019 -0400

    doxygen: add @file declarations for src/app
    
    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  | 5 +++++
 src/app/main/subsysmgr.c      | 8 ++++++++
 src/app/main/subsysmgr.h      | 5 +++++
 src/app/main/subsystem_list.c | 5 +++++
 4 files changed, 23 insertions(+)

diff --git a/src/app/config/quiet_level.c b/src/app/config/quiet_level.c
index f00d6b5a3..84bc0149b 100644
--- a/src/app/config/quiet_level.c
+++ b/src/app/config/quiet_level.c
@@ -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"
diff --git a/src/app/main/subsysmgr.c b/src/app/main/subsysmgr.c
index 5aa4fd76c..1f4bc840f 100644
--- a/src/app/main/subsysmgr.c
+++ b/src/app/main/subsysmgr.c
@@ -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"
 
diff --git a/src/app/main/subsysmgr.h b/src/app/main/subsysmgr.h
index d4426614e..f8bc83e0a 100644
--- a/src/app/main/subsysmgr.h
+++ b/src/app/main/subsysmgr.h
@@ -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
 
diff --git a/src/app/main/subsystem_list.c b/src/app/main/subsystem_list.c
index 1af9340c1..4a40702e7 100644
--- a/src/app/main/subsystem_list.c
+++ b/src/app/main/subsystem_list.c
@@ -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"



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits