doc: Clarify kfile_read() behaviour.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4617 38d2e660-2303-0410-9eaa-f027e97ec537

diff --git a/bertos/io/kfile.h b/bertos/io/kfile.h
index 040e04a8684495c99266103348d2995d278c2871..9b0b07d016aa27c8692c98b333827a3ace61e5b6 100644 (file)
--- a/bertos/io/kfile.h
+++ b/bertos/io/kfile.h
@@ -223,6 +223,12 @@ int kfile_genericClose(struct KFile *fd);
 /**
  * Read \a size bytes from file \a fd into \a buf.
  *
+ * This function reads at most the number of requested bytes into the
+ * provided buffer.
+ * The value returned may be less than the requested bytes in case EOF is
+ * reached OR an error occurred. You need to check the error conditions
+ * using kfile_error() to understand which case happened.
+ *
  * \note This function will block if there are less than \a size bytes
  *       to read.
  *