aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2017-11-17 10:56:58 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2017-11-17 10:56:58 +0000
commitdc52593ffb76e180d880b44b6d8277a053eb6c1a (patch)
treecd2f46702e9da02ebc8113f1d90004b062b4abdb
parent8ad523ae67244485a82c9d56820d4bbefd9d377c (diff)
downloadChibiOS-dc52593ffb76e180d880b44b6d8277a053eb6c1a.tar.gz
ChibiOS-dc52593ffb76e180d880b44b6d8277a053eb6c1a.tar.bz2
ChibiOS-dc52593ffb76e180d880b44b6d8277a053eb6c1a.zip
Improved documentation.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11028 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--os/hal/lib/complex/mfs/mfs.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/os/hal/lib/complex/mfs/mfs.c b/os/hal/lib/complex/mfs/mfs.c
index f513ea4cc..13497d493 100644
--- a/os/hal/lib/complex/mfs/mfs.c
+++ b/os/hal/lib/complex/mfs/mfs.c
@@ -886,6 +886,7 @@ void mfsStop(MFSDriver *mfsp) {
* @retval MFS_NO_ERROR if the operation has been successfully completed.
* @retval MFS_ERR_FLASH_FAILURE if the flash memory is unusable because HW
* failures. Makes the driver enter the @p MFS_ERROR state.
+ * @retval MFS_ERR_INTERNAL if an internal logic failure is detected.
*
* @api
*/
@@ -920,6 +921,7 @@ mfs_error_t mfsErase(MFSDriver *mfsp) {
* @retval MFS_ERR_NOT_FOUND if the specified id does not exists.
* @retval MFS_ERR_FLASH_FAILURE if the flash memory is unusable because HW
* failures. Makes the driver enter the @p MFS_ERROR state.
+ * @retval MFS_ERR_INTERNAL if an internal logic failure is detected.
*
* @api
*/
@@ -984,6 +986,7 @@ mfs_error_t mfsReadRecord(MFSDriver *mfsp, mfs_id_t id,
* operation.
* @retval MFS_ERR_FLASH_FAILURE if the flash memory is unusable because HW
* failures. Makes the driver enter the @p MFS_ERROR state.
+ * @retval MFS_ERR_INTERNAL if an internal logic failure is detected.
*
* @api
*/
@@ -1140,6 +1143,7 @@ mfs_error_t mfsEraseRecord(MFSDriver *mfsp, mfs_id_t id) {
* @retval MFS_ERR_INV_STATE if the driver is in not in @p MSG_READY state.
* @retval MFS_ERR_FLASH_FAILURE if the flash memory is unusable because HW
* failures. Makes the driver enter the @p MFS_ERROR state.
+ * @retval MFS_ERR_INTERNAL if an internal logic failure is detected.
*
* @api
*/