doc: updated api doc.

use @retval for the multiple return values.
This commit is contained in:
Hermet Park 2021-10-23 11:52:10 +09:00
parent a93b5b98a9
commit f24409a76d

View file

@ -1519,8 +1519,8 @@ public:
* Thus, if you wish to have a benefit of it, you must call sync() after the save() in the proper delayed time. * Thus, if you wish to have a benefit of it, you must call sync() after the save() in the proper delayed time.
* Otherwise, you can call sync() immediately. * Otherwise, you can call sync() immediately.
* *
* @return Result::Success when succeed. * @retval Result::Success when succeed.
* @return Result::InsufficientCondition otherwise. * @retval Result::InsufficientCondition otherwise.
* *
* @note The asynchronous tasking is dependent on the Saver module implementation. * @note The asynchronous tasking is dependent on the Saver module implementation.
* @see Saver::save() * @see Saver::save()