aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlloyd <[email protected]>2008-11-25 18:07:53 +0000
committerlloyd <[email protected]>2008-11-25 18:07:53 +0000
commit45cd53a6adeadf417a77353d0443bbe67d337087 (patch)
treea3152f63881b474ec46c6ddc11ee55316c6322de
parent0c315097134d3cda839de7b686703dcd99c28d14 (diff)
Add Doxygen comment for Timer::clock. Fix @return in benchmark.h and x509_ca.h
-rw-r--r--src/benchmark/benchmark.h2
-rw-r--r--src/cert/x509/x509_ca.h2
-rw-r--r--src/timer/timer.h4
3 files changed, 6 insertions, 2 deletions
diff --git a/src/benchmark/benchmark.h b/src/benchmark/benchmark.h
index f74913c19..145eb5500 100644
--- a/src/benchmark/benchmark.h
+++ b/src/benchmark/benchmark.h
@@ -43,7 +43,7 @@ namespace Botan {
* @param timer the timer to use
* @param rng the rng to use to generate random inputs
* @param af the algorithm factory used to create objects
-* @returns results a map from provider to speed in mebibytes per second
+* @return results a map from provider to speed in mebibytes per second
*/
std::map<std::string, double>
algorithm_benchmark(const std::string& name,
diff --git a/src/cert/x509/x509_ca.h b/src/cert/x509/x509_ca.h
index a9b6611d5..8f78181b2 100644
--- a/src/cert/x509/x509_ca.h
+++ b/src/cert/x509/x509_ca.h
@@ -95,7 +95,7 @@ class BOTAN_DLL X509_CA
* scheme.
* @param key will be the key to choose a padding scheme for
* @param alg_id will be set to the chosen scheme
-* @returns A PK_Signer object for generating signatures
+* @return A PK_Signer object for generating signatures
*/
BOTAN_DLL PK_Signer* choose_sig_format(const Private_Key& key,
AlgorithmIdentifier& alg_id);
diff --git a/src/timer/timer.h b/src/timer/timer.h
index dfa04ee3a..af2c58dcb 100644
--- a/src/timer/timer.h
+++ b/src/timer/timer.h
@@ -16,7 +16,11 @@ namespace Botan {
class BOTAN_DLL Timer : public EntropySource
{
public:
+ /**
+ @return nanoseconds resolution timestamp, unknown epoch
+ */
virtual u64bit clock() const = 0;
+
u32bit slow_poll(byte[], u32bit);
u32bit fast_poll(byte[], u32bit);