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/crypt_ops | |
| 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/crypt_ops')
| -rw-r--r-- | src/lib/crypt_ops/crypto_ope.c | 5 | ||||
| -rw-r--r-- | src/lib/crypt_ops/crypto_ope.h | 5 |
2 files changed, 8 insertions, 2 deletions
diff --git a/src/lib/crypt_ops/crypto_ope.c b/src/lib/crypt_ops/crypto_ope.c index ed832d852e..e4fef319e9 100644 --- a/src/lib/crypt_ops/crypto_ope.c +++ b/src/lib/crypt_ops/crypto_ope.c @@ -2,7 +2,8 @@ /* See LICENSE for licensing information */ /** - * A rudimentary order-preserving encryption scheme. + * @file crypto_ope.c + * @brief A rudimentary order-preserving encryption scheme. * * To compute the encryption of N, this scheme uses an AES-CTR stream to * generate M-byte values, and adds the first N of them together. (+1 each to @@ -143,7 +144,7 @@ crypto_ope_new(const uint8_t *key) return ope; } -/** Free all storage held in <>ope</b>. */ +/** Free all storage held in <b>ope</b>. */ void crypto_ope_free_(crypto_ope_t *ope) { diff --git a/src/lib/crypt_ops/crypto_ope.h b/src/lib/crypt_ops/crypto_ope.h index 9778dfe0f0..d6a81dbcc1 100644 --- a/src/lib/crypt_ops/crypto_ope.h +++ b/src/lib/crypt_ops/crypto_ope.h @@ -1,6 +1,11 @@ /* Copyright (c) 2018-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file crypto_ope.h + * @brief header for crypto_ope.c + **/ + #ifndef CRYPTO_OPE_H #define CRYPTO_OPE_H |