michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: update Kconfig options to use @option ALIAS

Browse source 
This updates Kconfig options in the Doxygen documentation to use the new
@option ALIAS. There are three categories of fixes:

* Use of `:option:` inside Doxygen headers, which is not valid (this is
  rST syntax!).
* Kconfig options that were just written as plain text and were no
  references were generated.
* Use of `@rst` blocks where the only reason for using them was to have
  Kconfig options resolved.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
This commit is contained in:
Fabio Utzig 2020-09-11 10:14:37 -03:00 • committed by Carles Cufí
commit 39fa56b834
7 changed files with 49 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/fs/littlefs.h
View file

@ -57,15 +57,15 @@ struct fs_littlefs {
* values are consistent with littlefs requirements.
*
* @note If you use a non-default configuration for cache size, you
* must also select :option:`CONFIG_FS_LITTLEFS_FC_MEM_POOL` to relax
* must also select @option{CONFIG_FS_LITTLEFS_FC_MEM_POOL} to relax
* the size constraints on per-file cache allocations.
*
* @param name the name for the structure. The defined object has
* file scope.
* @param read_sz see :option:`CONFIG_FS_LITTLEFS_READ_SIZE`
* @param prog_sz see :option:`CONFIG_FS_LITTLEFS_PROG_SIZE`
* @param cache_sz see :option:`CONFIG_FS_LITTLEFS_CACHE_SIZE`
* @param lookahead_sz see :option:`CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE`
* @param read_sz see @option{CONFIG_FS_LITTLEFS_READ_SIZE}
* @param prog_sz see @option{CONFIG_FS_LITTLEFS_PROG_SIZE}
* @param cache_sz see @option{CONFIG_FS_LITTLEFS_CACHE_SIZE}
* @param lookahead_sz see @option{CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE}
*/
#define FS_LITTLEFS_DECLARE_CUSTOM_CONFIG(name, read_sz, prog_sz, cache_sz, lookahead_sz) \
static uint8_t __aligned(4) name ## _read_buffer[cache_sz]; \