doc: Various documentation updates.

[bertos.git] / bertos / fs / fat.h

diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h
index d0da925d75ce113595837ea92513bd0592b2db89..34b20bbac1a7e2725fd562264984857384509ae0 100644 (file)
--- a/bertos/fs/fat.h
+++ b/bertos/fs/fat.h
@@ -65,6 +65,10 @@ INLINE FatFile * FATFILE_CAST(KFile *fd)
 
 /**
  * Initialize \a file and open \a file_path for reading.
+ * \param file A pointer to a FatFile structure.
+ * \param file_path The file path on the filesystem.
+ * \param mode Open mode for the file.
+ * \sa ff.h for return code meaning and \a mode flags.
  */
 FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);