linux-kernel - [asahilinux:t8112/bringup 18/19] drivers/hid/hid-magicmouse.c:575: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <202207081050.ZuYUDYpP-lkp@intel.com>
Date:   Fri, 8 Jul 2022 10:05:28 +0800
From:   kernel test robot <lkp@...el.com>
To:     Hector Martin <marcan@...can.st>
Cc:     kbuild-all@...ts.01.org, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org
Subject: [asahilinux:t8112/bringup 18/19] drivers/hid/hid-magicmouse.c:575:
 warning: This comment starts with '/**', but isn't a kernel-doc comment.
 Refer Documentation/doc-guide/kernel-doc.rst

tree:   https://github.com/AsahiLinux/linux t8112/bringup
head:   0e7640fed025ba0ce4b845a0bbf2a5fdceab631d
commit: 086a493b890970d6e0afac83878a36fbb22ffd83 [18/19] hid: magicmouse: Add MTP multi-touch device support
config: i386-allyesconfig (https://download.01.org/0day-ci/archive/20220708/202207081050.ZuYUDYpP-lkp@intel.com/config)
compiler: gcc-11 (Debian 11.3.0-3) 11.3.0
reproduce (this is a W=1 build):
        # https://github.com/AsahiLinux/linux/commit/086a493b890970d6e0afac83878a36fbb22ffd83
        git remote add asahilinux https://github.com/AsahiLinux/linux
        git fetch --no-tags asahilinux t8112/bringup
        git checkout 086a493b890970d6e0afac83878a36fbb22ffd83
        # save the config file
        mkdir build_dir && cp config build_dir/.config
        make W=1 O=build_dir ARCH=i386 SHELL=/bin/bash drivers/hid/

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <lkp@...el.com>

All warnings (new ones prefixed by >>):

   drivers/hid/hid-magicmouse.c:171: warning: Function parameter or member 'pos' not described in 'magicmouse_sc'
   drivers/hid/hid-magicmouse.c:171: warning: Function parameter or member 'hdev' not described in 'magicmouse_sc'
   drivers/hid/hid-magicmouse.c:171: warning: Function parameter or member 'work' not described in 'magicmouse_sc'
   drivers/hid/hid-magicmouse.c:171: warning: Function parameter or member 'battery_timer' not described in 'magicmouse_sc'
   drivers/hid/hid-magicmouse.c:171: warning: Function parameter or member 'input_ops' not described in 'magicmouse_sc'
>> drivers/hid/hid-magicmouse.c:575: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * vendor trackpad report
   drivers/hid/hid-magicmouse.c:589: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * standard HID mouse report


vim +575 drivers/hid/hid-magicmouse.c

   573	
   574	/**
 > 575	 * vendor trackpad report
   576	 *
   577	 * @num_fingers:	the number of fingers being reported in @fingers
   578	 * @buttons:		same as HID buttons
   579	 */
   580	struct tp_header {
   581		// HID vendor part, up to 1751 bytes
   582		u8 unknown[22];
   583		u8 num_fingers;
   584		u8 buttons;
   585		u8 unknown3[14];
   586	};
   587	

-- 
0-DAY CI Kernel Test Service
https://01.org/lkp