ARM: 9319/1: 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.

Link: https://lore.kernel.org/oe-kbuild-all/202308112255.SK1J0rze-lkp@intel.com/
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: patches@armlinux.org.uk
Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>

diff --git a/arch/arm/common/sa1111.c b/arch/arm/common/sa1111.c
index 77c83ba81715a04bc21eb10fe3c7abd8dbb5c09a..1fbd7363cf118144b5d92595dbeecd382ec9698e 100644 (file)
--- a/arch/arm/common/sa1111.c
+++ b/arch/arm/common/sa1111.c
@@ -785,19 +785,6 @@ sa1111_init_one_child(struct sa1111 *sachip, struct resource *parent,
        return 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 device *dev)
 #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;