BRANDT_new() returns NULL on parameter failure

1 files changed, 2 insertions, 1 deletions

diff --git a/brandt.h b/brandt.h
index 101debf..6d68f0a 100644
--- a/brandt.h
+++ b/brandt.h
@@ -211,7 +211,8 @@ BRANDT_join (BRANDT_CbResult    result,
  * @param[in] outcome_public If 1, the auction winner and price will be public
  * to all participants, if 0, this information will only be revealed to the
  * winner and the seller.
- * @return A pointer, which should only be remembered and passed to
+ * @return If invalid parameters are passed, NULL is returned. Else the return
+ * value is a pointer, which should only be remembered and passed to
  * libbrandt functions when the client needs to refer to this auction. This is a
  * black-box pointer, do NOT dereference/change it or the data it points to!
  */