From 544548f6dbf4810d4a3917791d8904199283abf5 Mon Sep 17 00:00:00 2001 From: hasufell Date: Thu, 5 Jun 2014 17:11:51 +0200 Subject: [PATCH] DOC: improve function documentation --- include/ntru.h | 4 ++-- src/ntru_poly.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/include/ntru.h b/include/ntru.h index 19fb032..f15210d 100644 --- a/include/ntru.h +++ b/include/ntru.h @@ -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 diff --git a/src/ntru_poly.h b/src/ntru_poly.h index 6876ad3..19d4627 100644 --- a/src/ntru_poly.h +++ b/src/ntru_poly.h @@ -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