mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
When introducing 'struct spi_nor', a number of issues was added in its
kernel-doc comment:
- double article in the heading kernel-doc comment;
- "point" instead of "pointer" for the 'mtd' and 'dev' fields;
- "a" articles instead of "an" for the 'dev' field;
- acronyms in the lower case for the 'dev' field;
- missing "pointer to" for the 'priv' field.
Fix all of those at once...
Fixes: 6e602ef733
("mtd: spi-nor: add the basic data structures")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
Signed-off-by: Tudor Ambarus <tudor.ambarus@microchip.com>
This commit is contained in:
parent
150ccc1815
commit
40a571bc40
|
@ -327,10 +327,10 @@ struct spi_nor_manufacturer;
|
||||||
struct spi_nor_flash_parameter;
|
struct spi_nor_flash_parameter;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* struct spi_nor - Structure for defining a the SPI NOR layer
|
* struct spi_nor - Structure for defining the SPI NOR layer
|
||||||
* @mtd: point to a mtd_info structure
|
* @mtd: pointer to an mtd_info structure
|
||||||
* @lock: the lock for the read/write/erase/lock/unlock operations
|
* @lock: the lock for the read/write/erase/lock/unlock operations
|
||||||
* @dev: point to a spi device, or a spi nor controller device.
|
* @dev: pointer to an SPI device or an SPI NOR controller device
|
||||||
* @spimem: point to the spi mem device
|
* @spimem: point to the spi mem device
|
||||||
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
|
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
|
||||||
* layer is not DMA-able
|
* layer is not DMA-able
|
||||||
|
@ -354,7 +354,7 @@ struct spi_nor_flash_parameter;
|
||||||
* settings that can be overwritten by the spi_nor_fixups
|
* settings that can be overwritten by the spi_nor_fixups
|
||||||
* hooks, or dynamically when parsing the SFDP tables.
|
* hooks, or dynamically when parsing the SFDP tables.
|
||||||
* @dirmap: pointers to struct spi_mem_dirmap_desc for reads/writes.
|
* @dirmap: pointers to struct spi_mem_dirmap_desc for reads/writes.
|
||||||
* @priv: the private data
|
* @priv: pointer to the private data
|
||||||
*/
|
*/
|
||||||
struct spi_nor {
|
struct spi_nor {
|
||||||
struct mtd_info mtd;
|
struct mtd_info mtd;
|
||||||
|
|
Loading…
Reference in New Issue