DOC: random doxygen improvements
This commit is contained in:
@@ -108,8 +108,6 @@ string_delete(string *del_string);
|
||||
* fill with coefficients [out]
|
||||
* @param c array of polynomial coefficients, can be NULL
|
||||
* @param len size of the coefficient array, can be 0
|
||||
* @return newly allocated polynomial pointer, must be freed
|
||||
* with fmpz_poly_clear()
|
||||
*/
|
||||
void
|
||||
poly_new(fmpz_poly_t new_poly,
|
||||
|
||||
@@ -70,7 +70,9 @@ struct keypair {
|
||||
* consisting of public and private
|
||||
* components.
|
||||
*
|
||||
* @param pair store private and public components here [out]
|
||||
* @param pair store private and public components here (the
|
||||
* polynomials inside the struct will be automatically
|
||||
* initialized) [out]
|
||||
* @param f a random polynomial
|
||||
* @param g a random polynomial
|
||||
* @param params the NTRU context
|
||||
@@ -111,7 +113,7 @@ export_priv_key(char const * const filename,
|
||||
/**
|
||||
* Import the public key from a file.
|
||||
*
|
||||
* @param pub where to save the public key [out]
|
||||
* @param pub where to save the public key, must be initialized [out]
|
||||
* @param filename the file to get the public key from
|
||||
* @param params the NTRU context
|
||||
*/
|
||||
@@ -120,12 +122,14 @@ import_public_key(fmpz_poly_t pub,
|
||||
char const * const filename,
|
||||
const ntru_params *params);
|
||||
|
||||
|
||||
/**
|
||||
* Import the private key from a file and store him
|
||||
* along with his inverse.
|
||||
*
|
||||
* @param priv where to save the private key [out]
|
||||
* @param priv_inv where to save the inverse of the private key [out]
|
||||
* @param priv where to save the private key, must be initialized [out]
|
||||
* @param priv_inv where to save the inverse of the private key,
|
||||
* must be initialized [out]
|
||||
* @param filename the file to get the private key from
|
||||
* @param params the NTRU context
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user