From 3dfa07b401e5b14e14456708c138ee22e354c969 Mon Sep 17 00:00:00 2001 From: Paul Bakker Date: Wed, 30 Apr 2014 10:21:23 +0200 Subject: [PATCH] Clearer description for version_get_string_full() regarding 18 bytes --- include/polarssl/version.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/include/polarssl/version.h b/include/polarssl/version.h index 4e75d8729..185b1579b 100644 --- a/include/polarssl/version.h +++ b/include/polarssl/version.h @@ -71,8 +71,11 @@ void version_get_string( char *string ); /** * Get the full version string ("PolarSSL x.y.z"). * - * \param string The string that will receive the value. - * (Should be at least 18 bytes in size) + * \param string The string that will receive the value. The PolarSSL version + * string will use 18 bytes AT MOST including a terminating + * null byte. + * (So the buffer should be at least 18 bytes to receive this + * version string). */ void version_get_string_full( char *string );