diff options
author | Nick Mathewson <nickm@torproject.org> | 2019-10-26 11:13:29 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2019-10-26 11:13:29 -0400 |
commit | 39d09ea0810f74a7666d9d694903780a14b48ca2 (patch) | |
tree | e001b17f1d896520a21bf0a21e4b44433c5d5e6a /src/lib/tls | |
parent | e7993dc046a099075bc5f9f65a7bb1601686d03c (diff) | |
download | tor-39d09ea0810f74a7666d9d694903780a14b48ca2.tar.gz tor-39d09ea0810f74a7666d9d694903780a14b48ca2.zip |
doxygen: add @file declarations for src/lib
If a file doesn't use the file command (either \file or @file),
Doxygen won't try to process it.
These declarations also turned up a doxygen warning for
crypto_ope.c; I fixed that too.
Diffstat (limited to 'src/lib/tls')
-rw-r--r-- | src/lib/tls/tortls.c | 5 | ||||
-rw-r--r-- | src/lib/tls/tortls_internal.h | 5 | ||||
-rw-r--r-- | src/lib/tls/tortls_st.h | 8 |
3 files changed, 18 insertions, 0 deletions
diff --git a/src/lib/tls/tortls.c b/src/lib/tls/tortls.c index 1aff40c437..f3c117efa3 100644 --- a/src/lib/tls/tortls.c +++ b/src/lib/tls/tortls.c @@ -3,6 +3,11 @@ * Copyright (c) 2007-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file tortls.c + * @brief Shared functionality for our TLS backends. + **/ + #define TORTLS_PRIVATE #define TOR_X509_PRIVATE #include "lib/tls/x509.h" diff --git a/src/lib/tls/tortls_internal.h b/src/lib/tls/tortls_internal.h index 866483a94c..a7aee524f3 100644 --- a/src/lib/tls/tortls_internal.h +++ b/src/lib/tls/tortls_internal.h @@ -3,6 +3,11 @@ * Copyright (c) 2007-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file tortls_internal.h + * @brief Declare internal functions for lib/tls + **/ + #ifndef TORTLS_INTERNAL_H #define TORTLS_INTERNAL_H diff --git a/src/lib/tls/tortls_st.h b/src/lib/tls/tortls_st.h index 73f6e6ecca..37935894f3 100644 --- a/src/lib/tls/tortls_st.h +++ b/src/lib/tls/tortls_st.h @@ -6,6 +6,14 @@ #ifndef TOR_TORTLS_ST_H #define TOR_TORTLS_ST_H +/** + * @file tortls_st.h + * @brief Structure declarations for internal TLS types. + * + * These should generally be treated as opaque outside of the + * lib/tls module. + **/ + #include "lib/net/socket.h" #define TOR_TLS_MAGIC 0x71571571 |