michaelh/zephyr
1
0
Fork 0
Code Releases Activity

fs: littlefs: doc: clean bad doxygen references.

Browse source 
:c:func:, :c:macro: etc shoud not be used in Doxygen comments, as they
are Sphinx roles.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-08-28 11:33:03 +02:00 • committed by Anas Nashif
commit f59dbb39d5
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/zephyr/fs/littlefs.h
View file

@ -45,14 +45,13 @@ struct fs_littlefs {
* This defines static arrays required for caches, and initializes the
* littlefs configuration structure to use the provided values instead
* of the global Kconfig defaults. A pointer to the named object must
* be stored in the ``.fs_data`` field of a :c:type:`struct fs_mount`
* object.
* be stored in the @ref fs_mount_t.fs_data field of a @ref fs_mount_t object.
*
* To define an instance for the Kconfig defaults, use
* :c:macro:`FS_LITTLEFS_DECLARE_DEFAULT_CONFIG`.
* @ref FS_LITTLEFS_DECLARE_DEFAULT_CONFIG.
*
* To completely control file system configuration the application can
* directly define and initialize a :c:type:`struct fs_littlefs`
* directly define and initialize a @ref fs_littlefs
* object. The application is responsible for ensuring the configured
* values are consistent with littlefs requirements.
*