KEYGEN: fix doxygen comments

2014-06-05 19:13:13 +02:00
parent cffc6545ae
commit 1122dc6763
1 changed files with 2 additions and 0 deletions
--- a/src/ntru_keypair.h
+++ b/src/ntru_keypair.h
@@ -71,6 +71,8 @@ struct keypair {
 * @param g a random polynomial
 * @param pair store private and public components here [out]
 * @param params the NTRU context
+ * @return true for success, false if f or g are not invertible
+ * (then the caller hast to try different ones)
 */
 bool
 ntru_create_keypair(