• Bagas Sanjaya's avatar
    HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers · d5e649a5
    Bagas Sanjaya authored
    Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found
    6 warnings for hid_dbg() wrapper functions below:
    
    drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
     * Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
    drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on line:
     * Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
    drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump
    drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
     * Dump tablet interface frame parameters with hid_dbg(), indented with two
    drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on line:
     * Dump tablet interface frame parameters with hid_dbg(), indented with two
    drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump
    drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
     * Dump tablet interface parameters with hid_dbg().
    drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on line:
     * Dump tablet interface parameters with hid_dbg().
    
    One of them is reported by kernel test robot.
    
    Fix these warnings by properly format kernel-doc comment for these
    functions.
    
    Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/
    Fixes: a228809f ("HID: uclogic: Move param printing to a function")
    Reported-by: default avatarkernel test robot <lkp@intel.com>
    Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Tested-by: default avatarJosé Expósito <jose.exposito89@gmail.com>
    Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Cc: Nikolai Kondrashov <spbnick@gmail.com>
    Cc: Jiri Kosina <jikos@kernel.org>
    Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
    Cc: llvm@lists.linux.dev
    Cc: linux-input@vger.kernel.org
    Cc: linux-kernel@vger.kernel.org
    Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
    Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
    d5e649a5
hid-uclogic-params.c 37.3 KB