Commit c95de73d authored by Randy Dunlap's avatar Randy Dunlap Committed by Miquel Raynal
Browse files

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
parent 3e9c49d4

include/linux/mtd/spear_smi.h

+10 −9
Original line number Diff line number Diff line
@@ -31,12 +31,12 @@ 
 * struct spear_smi_flash_info - platform structure for passing flash

 * information

 *

 * name: name of the serial nor flash for identification

 * mem_base: the memory base on which the flash is mapped

 * size: size of the flash in bytes

 * partitions: parition details

 * nr_partitions: number of partitions

 * fast_mode: whether flash supports fast mode

 * @name: name of the serial nor flash for identification

 * @mem_base: the memory base on which the flash is mapped

 * @size: size of the flash in bytes

 * @partitions: parition details

 * @nr_partitions: number of partitions

 * @fast_mode: whether flash supports fast mode

 */



struct spear_smi_flash_info {
@@ -51,9 +51,10 @@ struct spear_smi_flash_info { 
/**

 * struct spear_smi_plat_data - platform structure for configuring smi

 *

 * clk_rate: clk rate at which SMI must operate

 * num_flashes: number of flashes present on board

 * board_flash_info: specific details of each flash present on board

 * @clk_rate: clk rate at which SMI must operate

 * @num_flashes: number of flashes present on board

 * @board_flash_info: specific details of each flash present on board

 * @np: array of DT node pointers for all possible flash chip devices

 */

struct spear_smi_plat_data {

	unsigned long clk_rate;