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

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>

authored by

Randy Dunlap and committed by
Russell King (Oracle)
414f28a9 0bb80ecc

+14 -13
+14 -13
arch/arm/common/sa1111.c
··· 785 785 return ret; 786 786 } 787 787 788 - /** 789 - * sa1111_probe - probe for a single SA1111 chip. 790 - * @phys_addr: physical address of device. 791 - * 792 - * Probe for a SA1111 chip. This must be called 793 - * before any other SA1111-specific code. 794 - * 795 - * Returns: 796 - * %-ENODEV device not found. 797 - * %-EBUSY physical address already marked in-use. 798 - * %-EINVAL no platform data passed 799 - * %0 successful. 800 - */ 801 788 static int __sa1111_probe(struct device *me, struct resource *mem, int irq) 802 789 { 803 790 struct sa1111_platform_data *pd = me->platform_data; ··· 1095 1108 #define sa1111_resume_noirq NULL 1096 1109 #endif 1097 1110 1111 + /** 1112 + * sa1111_probe - probe for a single SA1111 chip. 1113 + * @pdev: platform device. 1114 + * 1115 + * Probe for a SA1111 chip. This must be called 1116 + * before any other SA1111-specific code. 1117 + * 1118 + * Returns: 1119 + * * %-ENODEV - device not found. 1120 + * * %-ENOMEM - memory allocation failure. 1121 + * * %-EBUSY - physical address already marked in-use. 1122 + * * %-EINVAL - no platform data passed 1123 + * * %0 - successful. 1124 + */ 1098 1125 static int sa1111_probe(struct platform_device *pdev) 1099 1126 { 1100 1127 struct resource *mem;