• Randy Dunlap's avatar
    ARM: 9318/1: locomo: move kernel-doc to prevent warnings · b0a6da43
    Randy Dunlap authored
    Move the kernel-doc comments for locomo_probe() to immediately before
    that function instead of before __locomo_probe() to prevent
    kernel-doc warnings. Adjust the documented function parameters and
    make the return values compatible with ReST by adding bullets to them.
    Add more possible return values to the list.
    
    Prevents these warnings:
    
      arch/arm/common/locomo.c:368: warning: Function parameter or member 'me' not described in '__locomo_probe'
      arch/arm/common/locomo.c:368: warning: Function parameter or member 'mem' not described in '__locomo_probe'
      arch/arm/common/locomo.c:368: warning: Function parameter or member 'irq' not described in '__locomo_probe'
      arch/arm/common/locomo.c:368: warning: expecting prototype for locomo_probe(). Prototype was for __locomo_probe() instead
    
    Link: lore.kernel.org/r/202308050851.zAvHe6y7-lkp@intel.com
    
    Fixes: 5eb6e280 ("ARM: 9289/1: Allow pre-ARMv5 builds with ld.lld 16.0.0 and newer")
    Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Reported-by: default avatarkernel test robot <lkp@intel.com>
    Cc: Nick Desaulniers <ndesaulniers@google.com>
    Cc: Arnd Bergmann <arnd@arndb.de>
    Cc: Nathan Chancellor <nathan@kernel.org>
    Cc: linux-arm-kernel@lists.infradead.org
    Cc: patches@armlinux.org.uk
    Signed-off-by: default avatarRussell King (Oracle) <rmk+kernel@armlinux.org.uk>
    b0a6da43
locomo.c 22.9 KB