Updated documentation (Issue 328)

1 files changed, 8 insertions, 0 deletions

diff --git a/luc.h b/luc.h
index ea16a44a..5d114274 100644
--- a/luc.h
+++ b/luc.h
@@ -76,6 +76,14 @@ class InvertibleLUCFunction : public LUCFunction, public TrapdoorFunctionInverse
 public:

 	virtual ~InvertibleLUCFunction() {}

 

+	//! \brief Create a LUC private key

+	//! \param rng a RandomNumberGenerator derived class

+	//! \param modulusBits the size of the modulus, in bits

+	//! \param eStart the desired starting public exponent

+	//! \details Initialize() creates a new keypair using a starting public exponent of 17.

+	//! \details This function overload of Initialize() creates a new keypair because it

+	//!   takes a RandomNumberGenerator() as a parameter. If you have an existing keypair,

+	//!   then use one of the other Initialize() overloads.

 	void Initialize(RandomNumberGenerator &rng, unsigned int modulusBits, const Integer &eStart=17);

 	void Initialize(const Integer &n, const Integer &e, const Integer &p, const Integer &q, const Integer &u)

 		{m_n = n; m_e = e; m_p = p; m_q = q; m_u = u;}