Skip to content

Commit efe892d

Browse files
MirkoCovizzilemrey
authored andcommitted
include: bm_zms: use proper Doxygen parameter formatting
Updates the Doxygen to use proper parameter formatting. Signed-off-by: Mirko Covizzi <[email protected]>
1 parent 24b90ee commit efe892d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

include/bm_zms.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ int bm_zms_mount(struct bm_zms_fs *fs);
137137
* @param fs Pointer to the file system.
138138
*
139139
* @retval 0 if the clear operation is queued successfully.
140-
* @retval -EACCES if `fs` is not mounted.
140+
* @retval -EACCES if @p fs is not mounted.
141141
* @retval -EIO if there is an internal error.
142142
*/
143143
int bm_zms_clear(struct bm_zms_fs *fs);
@@ -159,7 +159,7 @@ int bm_zms_clear(struct bm_zms_fs *fs);
159159
* On error, returns negative value of error codes defined in `errno.h`.
160160
* @retval -EACCES if BM_ZMS is still not initialized.
161161
* @retval -EIO if there is an internal error.
162-
* @retval -EINVAL if `len` is invalid.
162+
* @retval -EINVAL if @p len is invalid.
163163
*/
164164
ssize_t bm_zms_write(struct bm_zms_fs *fs, uint32_t id, const void *data, size_t len);
165165

@@ -190,7 +190,7 @@ int bm_zms_delete(struct bm_zms_fs *fs, uint32_t id);
190190
* @retval Number of bytes read (> 0) on success.
191191
* @retval -EACCES if BM_ZMS is still not initialized.
192192
* @retval -EIO if there is a memory read/write error.
193-
* @retval -ENOENT if there is no entry with the given `id`.
193+
* @retval -ENOENT if there is no entry with the given @p id.
194194
*/
195195
ssize_t bm_zms_read(struct bm_zms_fs *fs, uint32_t id, void *data, size_t len);
196196

@@ -210,7 +210,7 @@ ssize_t bm_zms_read(struct bm_zms_fs *fs, uint32_t id, void *data, size_t len);
210210
* @retval Number of bytes read (> 0) on success.
211211
* @retval -EACCES if BM_ZMS is still not initialized.
212212
* @retval -EIO if there is a memory read/write error.
213-
* @retval -ENOENT if there is no entry with the given `id` and history counter.
213+
* @retval -ENOENT if there is no entry with the given @p id and history counter.
214214
*/
215215
ssize_t bm_zms_read_hist(struct bm_zms_fs *fs, uint32_t id, void *data, size_t len, uint32_t cnt);
216216

@@ -222,10 +222,10 @@ ssize_t bm_zms_read_hist(struct bm_zms_fs *fs, uint32_t id, void *data, size_t l
222222
*
223223
* @return Data length contained in the ATE. On success, it will be equal to the number of bytes
224224
* in the ATE. On error, returns negative value of error codes defined in `errno.h`.
225-
* @retval Length of the entry with the given `id` (> 0) on success.
225+
* @retval Length of the entry with the given @p id (> 0) on success.
226226
* @retval -EACCES if BM_ZMS is still not initialized.
227227
* @retval -EIO if there is a memory read/write error.
228-
* @retval -ENOENT if there is no entry with the given id and history counter.
228+
* @retval -ENOENT if there is no entry with the given @p id and history counter.
229229
*/
230230
ssize_t bm_zms_get_data_length(struct bm_zms_fs *fs, uint32_t id);
231231

0 commit comments

Comments
 (0)