fs: littlefs: doc: clean bad doxygen references.
: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:
parent
f9e17b815f
commit
f59dbb39d5
1 changed files with 3 additions and 4 deletions
|
@ -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.
|
||||
*
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue