From 766a5d0206ed31a47088880668566c96fbba24f8 Mon Sep 17 00:00:00 2001
From: Paul Bakker
Date: Wed, 26 Mar 2014 11:51:25 +0100
Subject: [PATCH] Updated documentation for seed functions w.r.t. return values
---
include/polarssl/ctr_drbg.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/polarssl/ctr_drbg.h b/include/polarssl/ctr_drbg.h
index 8b0f38a15..3b2b27c08 100644
--- a/include/polarssl/ctr_drbg.h
+++ b/include/polarssl/ctr_drbg.h
@@ -204,7 +204,8 @@ int ctr_drbg_random( void *p_rng,
* \param ctx CTR_DRBG context
* \param path Name of the file
*
- * \return 0 if successful, 1 on file error, or
+ * \return 0 if successful,
+ * POLARSSL_ERR_CTR_DRBG_FILE_IO_ERROR on file error, or
* POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED
*/
int ctr_drbg_write_seed_file( ctr_drbg_context *ctx, const char *path );
@@ -216,7 +217,8 @@ int ctr_drbg_write_seed_file( ctr_drbg_context *ctx, const char *path );
* \param ctx CTR_DRBG context
* \param path Name of the file
*
- * \return 0 if successful, 1 on file error,
+ * \return 0 if successful,
+ * POLARSSL_ERR_CTR_DRBG_FILE_IO_ERROR on file error,
* POLARSSL_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED or
* POLARSSL_ERR_CTR_DRBG_INPUT_TOO_BIG
*/