Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

mtd: spear_smi: fix kernel-doc warnings <linux/mtd/spear_smi.h>

Correct most kernel-doc warnings in include/linux/mtd/spear_smi.h
by adding a leading '@' to the description of struct members.
Add a new description for the missing @np member.

Warning: spear_smi.h:48 struct member 'name' not described
in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'mem_base' not described
in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'size' not described
in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'partitions' not described
in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'nr_partitions' not described
in 'spear_smi_flash_info'
Warning: spear_smi.h:48 struct member 'fast_mode' not described
in 'spear_smi_flash_info'
Warning: spear_smi.h:62 struct member 'clk_rate' not described
in 'spear_smi_plat_data'
Warning: spear_smi.h:62 struct member 'num_flashes' not described
in 'spear_smi_plat_data'
Warning: spear_smi.h:62 struct member 'board_flash_info' not described
in 'spear_smi_plat_data'
Warning: spear_smi.h:62 struct member 'np' not described
in 'spear_smi_plat_data'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>

authored by

Randy Dunlap and committed by
Miquel Raynal
c95de73d 3e9c49d4

+10 -9
+10 -9
include/linux/mtd/spear_smi.h
··· 31 31 * struct spear_smi_flash_info - platform structure for passing flash 32 32 * information 33 33 * 34 - * name: name of the serial nor flash for identification 35 - * mem_base: the memory base on which the flash is mapped 36 - * size: size of the flash in bytes 37 - * partitions: parition details 38 - * nr_partitions: number of partitions 39 - * fast_mode: whether flash supports fast mode 34 + * @name: name of the serial nor flash for identification 35 + * @mem_base: the memory base on which the flash is mapped 36 + * @size: size of the flash in bytes 37 + * @partitions: parition details 38 + * @nr_partitions: number of partitions 39 + * @fast_mode: whether flash supports fast mode 40 40 */ 41 41 42 42 struct spear_smi_flash_info { ··· 51 51 /** 52 52 * struct spear_smi_plat_data - platform structure for configuring smi 53 53 * 54 - * clk_rate: clk rate at which SMI must operate 55 - * num_flashes: number of flashes present on board 56 - * board_flash_info: specific details of each flash present on board 54 + * @clk_rate: clk rate at which SMI must operate 55 + * @num_flashes: number of flashes present on board 56 + * @board_flash_info: specific details of each flash present on board 57 + * @np: array of DT node pointers for all possible flash chip devices 57 58 */ 58 59 struct spear_smi_plat_data { 59 60 unsigned long clk_rate;