aboutsummaryrefslogtreecommitdiffstats
path: root/src/math
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-15 21:59:23 +0000
committerlloyd <[email protected]>2010-06-15 21:59:23 +0000
commit416695f7363c4e93eaeaea23427a1fed3ad73cab (patch)
treeff1482f22f176733305583ad56855dae997d0d6d /src/math
parent6565cf0df1ed88a818aecf6de7635531e05c0871 (diff)
Fix a few hundred Doxygen warnings
Diffstat (limited to 'src/math')
-rw-r--r--src/math/bigint/bigint.h15
1 files changed, 11 insertions, 4 deletions
diff --git a/src/math/bigint/bigint.h b/src/math/bigint/bigint.h
index 0bb51fd20..cd1aebf00 100644
--- a/src/math/bigint/bigint.h
+++ b/src/math/bigint/bigint.h
@@ -361,14 +361,21 @@ class BOTAN_DLL BigInt
*/
void binary_decode(const MemoryRegion<byte>& buf);
- u32bit encoded_size(Base = Binary) const;
+ /**
+ * @param base the base to measure the size for
+ * @return size of this integer in base base
+ */
+ u32bit encoded_size(Base base = Binary) const;
/**
- @param rng a random number generator
- @result a random integer between min and max
+ * @param rng a random number generator
+ * @param min the minimum value
+ * @param max the maximum value
+ * @return a random integer between min and max
*/
static BigInt random_integer(RandomNumberGenerator& rng,
- const BigInt& min, const BigInt& max);
+ const BigInt& min,
+ const BigInt& max);
/**
* Encode the integer value from a BigInt to a SecureVector of bytes