More Doxygen

3 files changed, 17 insertions, 2 deletions

diff --git a/src/entropy/entropy_src.h b/src/entropy/entropy_src.h
index 898d650ce..fa61d9ea8 100644
--- a/src/entropy/entropy_src.h
+++ b/src/entropy/entropy_src.h
@@ -99,6 +99,10 @@ class BOTAN_DLL Entropy_Accumulator
 class BOTAN_DLL Entropy_Accumulator_BufferedComputation : public Entropy_Accumulator
    {
    public:
+      /**
+      * @param sink the hash or MAC we are feeding the poll data into
+      * @param goal is how many bits we want to collect in this poll
+      */
       Entropy_Accumulator_BufferedComputation(BufferedComputation& sink,
                                               u32bit goal) :
          Entropy_Accumulator(goal), entropy_sink(sink) {}
diff --git a/src/entropy/unix_procs/unix_cmd.h b/src/entropy/unix_procs/unix_cmd.h
index d233577d1..3abca8f37 100644
--- a/src/entropy/unix_procs/unix_cmd.h
+++ b/src/entropy/unix_procs/unix_cmd.h
@@ -20,6 +20,10 @@ namespace Botan {
 */
 struct Unix_Program
    {
+   /**
+   * @param n is the name and arguments of what we are going run
+   * @param p is the priority level (lower prio numbers get polled first)
+   */
    Unix_Program(const char* n, u32bit p)
       { name_and_args = n; priority = p; working = true; }
 
diff --git a/src/math/numbertheory/numthry.h b/src/math/numbertheory/numthry.h
index 146f158b6..9a1005413 100644
--- a/src/math/numbertheory/numthry.h
+++ b/src/math/numbertheory/numthry.h
@@ -57,9 +57,16 @@ BigInt BOTAN_DLL inverse_mod(const BigInt& x,
                              const BigInt& modulus);
 
 /**
-* Jacobi function
+* Compute the Jacobi symbol. If n is prime, this is equivalent
+* to the Legendre symbol.
+* @see http://mathworld.wolfram.com/JacobiSymbol.html
+*
+* @param a is a non-negative integer
+* @param n is an odd integer > 1
+* @return (n / m)
 */
-s32bit BOTAN_DLL jacobi(const BigInt&, const BigInt&);
+s32bit BOTAN_DLL jacobi(const BigInt& a,
+                        const BigInt& n);
 
 /**
 * Modular exponentation