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

virt: vbox: linux: fix all kernel-doc warnings

Use kernel-doc format for functions that are almost complete in their
kernel-doc comments.
For other functions, just change the comment to a common C comment.
This prevents 7 kernel-doc warnings.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20231222052521.14333-2-rdunlap@infradead.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Randy Dunlap and committed by
Greg Kroah-Hartman
2fd34a5d 8974a86d

+12 -10
+12 -10
drivers/virt/vboxguest/vboxguest_linux.c
··· 81 81 } 82 82 83 83 /** 84 - * Close device. 85 - * Return: 0 on success, negated errno on failure. 84 + * vbg_misc_device_close - Close device. 86 85 * @inode: Pointer to inode info structure. 87 86 * @filp: Associated file pointer. 87 + * 88 + * Return: %0 on success, negated errno on failure. 88 89 */ 89 90 static int vbg_misc_device_close(struct inode *inode, struct file *filp) 90 91 { ··· 95 94 } 96 95 97 96 /** 98 - * Device I/O Control entry point. 99 - * Return: 0 on success, negated errno on failure. 97 + * vbg_misc_device_ioctl - Device I/O Control entry point. 100 98 * @filp: Associated file pointer. 101 99 * @req: The request specified to ioctl(). 102 100 * @arg: The argument specified to ioctl(). 101 + * 102 + * Return: %0 on success, negated errno on failure. 103 103 */ 104 104 static long vbg_misc_device_ioctl(struct file *filp, unsigned int req, 105 105 unsigned long arg) ··· 175 173 return ret; 176 174 } 177 175 178 - /** The file_operations structures. */ 176 + /* The file_operations structures. */ 179 177 static const struct file_operations vbg_misc_device_fops = { 180 178 .owner = THIS_MODULE, 181 179 .open = vbg_misc_device_open, ··· 195 193 #endif 196 194 }; 197 195 198 - /** 196 + /* 199 197 * Called when the input device is first opened. 200 198 * 201 199 * Sets up absolute mouse reporting. ··· 208 206 return vbg_core_set_mouse_status(gdev, feat); 209 207 } 210 208 211 - /** 209 + /* 212 210 * Called if all open handles to the input device are closed. 213 211 * 214 212 * Disables absolute reporting. ··· 220 218 vbg_core_set_mouse_status(gdev, 0); 221 219 } 222 220 223 - /** 221 + /* 224 222 * Creates the kernel input device. 225 223 * 226 224 * Return: 0 on success, negated errno on failure. ··· 279 277 }; 280 278 ATTRIBUTE_GROUPS(vbg_pci); 281 279 282 - /** 280 + /* 283 281 * Does the PCI detection and init of the device. 284 282 * 285 283 * Return: 0 on success, negated errno on failure. ··· 455 453 } 456 454 EXPORT_SYMBOL(vbg_put_gdev); 457 455 458 - /** 456 + /* 459 457 * Callback for mouse events. 460 458 * 461 459 * This is called at the end of the ISR, after leaving the event spinlock, if