ARM: sa1111: fix sa1111_probe kernel-doc warnings
PATCH 1/1 ARM: sa1111: fix sa1111_probe kernel-doc warnings
Document only the platform_driver probe entry point in kernel-doc to prevent kernel-doc warnings:
sa1111.c:802: warning: Function parameter or member 'me' not described in '__sa1111_probe' sa1111.c:802: warning: Function parameter or member 'mem' not described in '__sa1111_probe' sa1111.c:802: warning: Function parameter or member 'irq' not described in '__sa1111_probe' sa1111.c:802: warning: expecting prototype for sa1111_probe(). Prototype was for __sa1111_probe() instead
Also, use ReST list format to enumerate the return values.
Signed-off-by Randy Dunlap <[email protected]>
Reported-by kernel test robot <[email protected]>
Cc Russell King <[email protected]>
---
KernelVersion: 6.5-rc6
arch/arm/common/sa1111.c | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-)
arch/arm/common/sa1111.c +14 -13
@@ -785,19 +785,6 @@ sa1111_init_one_child(struct sa1111 *sacreturn ret; } -/** -* sa1111_probe - probe for a single SA1111 chip. -* @phys_addr: physical address of device. -* -* Probe for a SA1111 chip. This must be called -* before any other SA1111-specific code. -* -* Returns: -* %-ENODEV device not found. -* %-EBUSY physical address already marked in-use. -* %-EINVAL no platform data passed -* %0 successful. -*/ static int __sa1111_probe (struct device *me,struct resource *mem,int irq) {struct sa1111_platform_data *pd = me->platform_data;
@@ -1108,6 +1095,20 @@ static int sa1111_resume_noirq(struct de#define sa1111_resume_noirq NULL#endif +/** +* sa1111_probe - probe for a single SA1111 chip. +* @pdev: platform device. +* +* Probe for a SA1111 chip. This must be called +* before any other SA1111-specific code. +* +* Returns: +* * %-ENODEV - device not found. +* * %-ENOMEM - memory allocation failure. +* * %-EBUSY - physical address already marked in-use. +* * %-EINVAL - no platform data passed +* * %0 - successful. +*/ static int sa1111_probe (struct platform_device *pdev) {struct resource *mem;