@@ -42,7 +42,7 @@ extern rt_list_t _mnt_list;
4242 * matching the given name. It returns a pointer to the pointer that holds
4343 * the matching filesystem type (or the end-of-list pointer if not found).
4444 *
45- * @param name The name of the filesystem type to find
45+ * @param[in] name The name of the filesystem type to find
4646 * @return struct dfs_filesystem_type** Pointer to the pointer containing
4747 * the matching filesystem type, or the end-of-list pointer if not found
4848 */
@@ -75,7 +75,7 @@ struct dfs_filesystem_type *dfs_filesystems(void)
7575 *
7676 * This function registers a new filesystem type with the global filesystem type list.
7777 *
78- * @param fs Pointer to the filesystem type to register
78+ * @param[in] fs Pointer to the filesystem type to register
7979 * @return int 0 on success, or a negative error code on failure
8080 */
8181int dfs_register (struct dfs_filesystem_type * fs )
@@ -102,7 +102,7 @@ int dfs_register(struct dfs_filesystem_type *fs)
102102 *
103103 * This function unregisters a filesystem type from the global filesystem type list.
104104 *
105- * @param fs Pointer to the filesystem type to unregister
105+ * @param[in] fs Pointer to the filesystem type to unregister
106106 * @return int 0 on success, or a negative error code on failure
107107 */
108108int dfs_unregister (struct dfs_filesystem_type * fs )
@@ -136,9 +136,9 @@ int dfs_unregister(struct dfs_filesystem_type *fs)
136136 *
137137 * This function remounts a filesystem at the specified path with the given flags.
138138 *
139- * @param path The path of the filesystem to remount
140- * @param flags The remount flags (see MS_REMOUNT and MS_RMT_MASK)
141- * @param data Pointer to additional data required for remounting
139+ * @param[in] path The path of the filesystem to remount
140+ * @param[in] flags The remount flags (see MS_REMOUNT and MS_RMT_MASK)
141+ * @param[in] data Pointer to additional data required for remounting
142142 * @return int 0 on success, or a negative error code on failure
143143 */
144144int dfs_remount (const char * path , rt_ubase_t flags , void * data )
@@ -201,11 +201,11 @@ int dfs_remount(const char *path, rt_ubase_t flags, void *data)
201201 * This function mounts a filesystem of the specified type at the given path with optional device.
202202 * It handles both root filesystem mounting and regular filesystem mounting scenarios.
203203 *
204- * @param device_name The name of the device to mount (optional)
205- * @param path The path of the mount point
206- * @param filesystemtype The type of the filesystem to mount
207- * @param rwflag The read/write flags (see MS_RDONLY, MS_RDWR, etc.)
208- * @param data Pointer to additional data required for mounting
204+ * @param[in] device_name The name of the device to mount (optional)
205+ * @param[in] path The path of the mount point
206+ * @param[in] filesystemtype The type of the filesystem to mount
207+ * @param[in] rwflag The read/write flags (see MS_RDONLY, MS_RDWR, etc.)
208+ * @param[in] data Pointer to additional data required for mounting
209209 *
210210 * @return int RT_EOK on success, negative error code on failure:
211211 * - EPERM: Path normalization failed or mount operation failed
@@ -428,8 +428,8 @@ int dfs_mount(const char *device_name,
428428 * 3. Checks if the filesystem can be safely unmounted
429429 * 4. Performs cleanup operations if unmounting is successful
430430 *
431- * @param specialfile The path of the filesystem to unmount
432- * @param flags Unmount flags (MNT_FORCE for forced unmount)
431+ * @param[in] specialfile The path of the filesystem to unmount
432+ * @param[in] flags Unmount flags (MNT_FORCE for forced unmount)
433433 *
434434 * @return int RT_EOK on success, negative error code on failure:
435435 * - EBUSY: Filesystem is busy (in use or has child mounts)
@@ -508,7 +508,7 @@ int dfs_unmount(const char *specialfile)
508508 * This function checks if the given mount point is mounted. It returns 0 if the mount point is mounted,
509509 * and -1 otherwise.
510510 *
511- * @param mnt The mount point to check
511+ * @param[in] mnt The mount point to check
512512 *
513513 * @return int 0 if mounted, -1 otherwise
514514 */
@@ -534,8 +534,8 @@ int dfs_is_mounted(struct dfs_mnt *mnt)
534534 * 3. Calls the filesystem-specific mkfs operation
535535 * 4. Handles page cache cleanup if successful (when RT_USING_PAGECACHE is enabled)
536536 *
537- * @param fs_name Name of the filesystem type to create (e.g., "elm", "romfs")
538- * @param device_name Name of the device to create filesystem on (optional)
537+ * @param[in] fs_name Name of the filesystem type to create (e.g., "elm", "romfs")
538+ * @param[in] device_name Name of the device to create filesystem on (optional)
539539 *
540540 * @return int RT_EOK on success, negative error code on failure:
541541 * - RT_ERROR: General error
@@ -612,8 +612,8 @@ int dfs_mkfs(const char *fs_name, const char *device_name)
612612 * 2. Looks up the mount point for the path
613613 * 3. Calls the filesystem-specific statfs operation if available
614614 *
615- * @param path The path to query filesystem statistics for
616- * @param buffer Pointer to statfs structure to store the results
615+ * @param[in] path The path to query filesystem statistics for
616+ * @param[out] buffer Pointer to statfs structure to store the results
617617 *
618618 * @return int RT_EOK on success, negative error code on failure:
619619 * - RT_ERROR: General error (invalid path or filesystem not found)
@@ -656,7 +656,7 @@ int dfs_statfs(const char *path, struct statfs *buffer)
656656/**
657657 * this function will return the mounted path for specified device.
658658 *
659- * @param device the device object which is mounted.
659+ * @param[in] device the device object which is mounted.
660660 *
661661 * @return the mounted path or NULL if none device mounted.
662662 */
@@ -670,9 +670,9 @@ const char *dfs_filesystem_get_mounted_path(struct rt_device *device)
670670/**
671671 * this function will fetch the partition table on specified buffer.
672672 *
673- * @param part the returned partition structure.
674- * @param buf the buffer contains partition table.
675- * @param pindex the index of partition table to fetch.
673+ * @param[out] part the returned partition structure.
674+ * @param[in] buf the buffer contains partition table.
675+ * @param[in] pindex the index of partition table to fetch.
676676 *
677677 * @return RT_EOK on successful or -RT_ERROR on failed.
678678 */
0 commit comments