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

[dgoulet@xxxxxxxxxxxxxx]

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

    doxygen: add @file declarations for src/core/crypto
    
    If a file doesn't use the file command (either \file or @file),
    Doxygen won't try to process it.
---
 src/core/crypto/hs_ntor.h      | 5 +++++
 src/core/crypto/onion_ntor.h   | 5 +++++
 src/core/crypto/relay_crypto.c | 5 +++++
 3 files changed, 15 insertions(+)

diff --git a/src/core/crypto/hs_ntor.h b/src/core/crypto/hs_ntor.h
index e5a517191..5a70974a0 100644
--- a/src/core/crypto/hs_ntor.h
+++ b/src/core/crypto/hs_ntor.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2017-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file hs_ntor.h
+ * @brief Header for hs_ntor.c
+ **/
+
 #ifndef TOR_HS_NTOR_H
 #define TOR_HS_NTOR_H
 
diff --git a/src/core/crypto/onion_ntor.h b/src/core/crypto/onion_ntor.h
index 51e72b408..ea504c105 100644
--- a/src/core/crypto/onion_ntor.h
+++ b/src/core/crypto/onion_ntor.h
@@ -1,6 +1,11 @@
 /* Copyright (c) 2012-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file onion_ntor.h
+ * @brief Header for onion_ntor.c
+ **/
+
 #ifndef TOR_ONION_NTOR_H
 #define TOR_ONION_NTOR_H
 
diff --git a/src/core/crypto/relay_crypto.c b/src/core/crypto/relay_crypto.c
index 8a285131a..3213e6a47 100644
--- a/src/core/crypto/relay_crypto.c
+++ b/src/core/crypto/relay_crypto.c
@@ -4,6 +4,11 @@
  * Copyright (c) 2007-2019, The Tor Project, Inc. */
 /* See LICENSE for licensing information */
 
+/**
+ * @file relay_crypto.h
+ * @brief Header for relay_crypto.c
+ **/
+
 #include "core/or/or.h"
 #include "core/or/circuitlist.h"
 #include "core/or/crypt_path.h"



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