hasufell
/
pqc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

DOC: improve function documentation

This commit is contained in:
hasufell 2014-06-05 17:11:51 +02:00
parent 7f54d6c0f7
commit 544548f6db
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/ntru.h
View File

@ -102,10 +102,10 @@ string_delete(string *del_string);
* Initializes and builds a polynomial with the
* coefficient values of c[] of size len within NTRU
* parameters and returns a newly allocated polynomial.
* For an empty polynom, both parameters can be NULL/0.
* For an empty polynom, both c and len can be NULL/0.
*
* @param new_poly the polynomial to initialize and
* fill with coefficients
* 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

4
src/ntru_poly.h
View File

@ -54,10 +54,10 @@ fmpz_cmp_si_n(const fmpz_t f, slong g);
* Initializes and builds a polynomial with the
* coefficient values of c[] of size len within NTRU
* parameters and returns a newly allocated polynomial.
* For an empty polynom, both parameters can be NULL/0.
* For an empty polynom, both c and len can be NULL/0.
*
* @param new_poly the polynomial to initialize and
* fill with coefficients
* 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