ARM: 9319/1: sa1111: fix sa1111_probe kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 21 Aug 2023 02:10:38 +0000 (03:10 +0100)
committerRussell King (Oracle) <rmk+kernel@armlinux.org.uk>
Thu, 5 Oct 2023 15:15:40 +0000 (16:15 +0100)
commit414f28a94222fe372a5b2378415895b9c4dc540f
tree8fc3f52dbde1a7cada364aaa29ed99885d7f8262
parent0bb80ecc33a8fb5a682236443c1e740d5c917d1d
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>
arch/arm/common/sa1111.c