aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-16 04:37:18 +0000
committerlloyd <[email protected]>2010-06-16 04:37:18 +0000
commit71557dc5873b2596c2e9551bb56b8e9bd9469849 (patch)
tree0a642f77896d4b63725d306a013f04f0ea797b43
parent71b73656661270ed9204b4e12ce15709467d9247 (diff)
Doxygen for divide.h
-rw-r--r--src/math/bigint/divide.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/math/bigint/divide.h b/src/math/bigint/divide.h
index 9445b137b..36aed7854 100644
--- a/src/math/bigint/divide.h
+++ b/src/math/bigint/divide.h
@@ -12,7 +12,17 @@
namespace Botan {
-void BOTAN_DLL divide(const BigInt&, const BigInt&, BigInt&, BigInt&);
+/**
+* BigInt Division
+* @param x an integer
+* @param y a non-zero integer
+* @param q will be set to x / y
+* @param r will be set to x % y
+*/
+void BOTAN_DLL divide(const BigInt& x,
+ const BigInt& y,
+ BigInt& q,
+ BigInt& r);
}