aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2017-12-16 10:59:51 -0500
committerJack Lloyd <[email protected]>2017-12-16 10:59:51 -0500
commitb6fa65d38fa9b8a95d8028e0ec811b44808e11a8 (patch)
tree3f91f6b31126e582a62f0fab408f1557110ad618
parent59c24b0ed65e1fdc6f64ae07d44fb08e9059266c (diff)
Avoid using @deprecated annotation here
Clang's documentation checker complains since it's not actually annotated as deprecated. Change comment to just indicate that it is not a public API function and will be removed in the future.
-rw-r--r--src/lib/pubkey/xmss/xmss_tools.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/lib/pubkey/xmss/xmss_tools.h b/src/lib/pubkey/xmss/xmss_tools.h
index 6e45e882d..e9f877eae 100644
--- a/src/lib/pubkey/xmss/xmss_tools.h
+++ b/src/lib/pubkey/xmss/xmss_tools.h
@@ -60,7 +60,9 @@ class XMSS_Tools final
static void concat(secure_vector<uint8_t>& target, const T& src, size_t len);
/**
- * @deprecated Determines the maximum number of threads to be used
+ * Not a public API function - will be removed in a future release.
+ *
+ * Determines the maximum number of threads to be used
* efficiently, based on runtime timining measurements. Ideally the
* result will correspond to the physical number of cores. On systems
* supporting simultaneous multi threading (SMT)
@@ -83,7 +85,7 @@ class XMSS_Tools final
private:
XMSS_Tools();
/**
- * @deprecated Measures the time t1 it takes to calculate hashes using
+ * Measures the time t1 it takes to calculate hashes using
* std::thread::hardware_concurrency() many threads and the time t2
* calculating the same number of hashes using
* std::thread::hardware_concurrency() / 2 threads.