Commit 2fd34a5d authored by Randy Dunlap's avatar Randy Dunlap Committed by Greg Kroah-Hartman

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: default avatarRandy 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.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 8974a86d
...@@ -81,10 +81,11 @@ static int vbg_misc_device_user_open(struct inode *inode, struct file *filp) ...@@ -81,10 +81,11 @@ static int vbg_misc_device_user_open(struct inode *inode, struct file *filp)
} }
/** /**
* Close device. * vbg_misc_device_close - Close device.
* Return: 0 on success, negated errno on failure.
* @inode: Pointer to inode info structure. * @inode: Pointer to inode info structure.
* @filp: Associated file pointer. * @filp: Associated file pointer.
*
* Return: %0 on success, negated errno on failure.
*/ */
static int vbg_misc_device_close(struct inode *inode, struct file *filp) static int vbg_misc_device_close(struct inode *inode, struct file *filp)
{ {
...@@ -94,11 +95,12 @@ static int vbg_misc_device_close(struct inode *inode, struct file *filp) ...@@ -94,11 +95,12 @@ static int vbg_misc_device_close(struct inode *inode, struct file *filp)
} }
/** /**
* Device I/O Control entry point. * vbg_misc_device_ioctl - Device I/O Control entry point.
* Return: 0 on success, negated errno on failure.
* @filp: Associated file pointer. * @filp: Associated file pointer.
* @req: The request specified to ioctl(). * @req: The request specified to ioctl().
* @arg: The argument specified to ioctl(). * @arg: The argument specified to ioctl().
*
* Return: %0 on success, negated errno on failure.
*/ */
static long vbg_misc_device_ioctl(struct file *filp, unsigned int req, static long vbg_misc_device_ioctl(struct file *filp, unsigned int req,
unsigned long arg) unsigned long arg)
...@@ -173,7 +175,7 @@ static long vbg_misc_device_ioctl(struct file *filp, unsigned int req, ...@@ -173,7 +175,7 @@ static long vbg_misc_device_ioctl(struct file *filp, unsigned int req,
return ret; return ret;
} }
/** The file_operations structures. */ /* The file_operations structures. */
static const struct file_operations vbg_misc_device_fops = { static const struct file_operations vbg_misc_device_fops = {
.owner = THIS_MODULE, .owner = THIS_MODULE,
.open = vbg_misc_device_open, .open = vbg_misc_device_open,
...@@ -193,7 +195,7 @@ static const struct file_operations vbg_misc_device_user_fops = { ...@@ -193,7 +195,7 @@ static const struct file_operations vbg_misc_device_user_fops = {
#endif #endif
}; };
/** /*
* Called when the input device is first opened. * Called when the input device is first opened.
* *
* Sets up absolute mouse reporting. * Sets up absolute mouse reporting.
...@@ -206,7 +208,7 @@ static int vbg_input_open(struct input_dev *input) ...@@ -206,7 +208,7 @@ static int vbg_input_open(struct input_dev *input)
return vbg_core_set_mouse_status(gdev, feat); return vbg_core_set_mouse_status(gdev, feat);
} }
/** /*
* Called if all open handles to the input device are closed. * Called if all open handles to the input device are closed.
* *
* Disables absolute reporting. * Disables absolute reporting.
...@@ -218,7 +220,7 @@ static void vbg_input_close(struct input_dev *input) ...@@ -218,7 +220,7 @@ static void vbg_input_close(struct input_dev *input)
vbg_core_set_mouse_status(gdev, 0); vbg_core_set_mouse_status(gdev, 0);
} }
/** /*
* Creates the kernel input device. * Creates the kernel input device.
* *
* Return: 0 on success, negated errno on failure. * Return: 0 on success, negated errno on failure.
...@@ -277,7 +279,7 @@ static struct attribute *vbg_pci_attrs[] = { ...@@ -277,7 +279,7 @@ static struct attribute *vbg_pci_attrs[] = {
}; };
ATTRIBUTE_GROUPS(vbg_pci); ATTRIBUTE_GROUPS(vbg_pci);
/** /*
* Does the PCI detection and init of the device. * Does the PCI detection and init of the device.
* *
* Return: 0 on success, negated errno on failure. * Return: 0 on success, negated errno on failure.
...@@ -453,7 +455,7 @@ void vbg_put_gdev(struct vbg_dev *gdev) ...@@ -453,7 +455,7 @@ void vbg_put_gdev(struct vbg_dev *gdev)
} }
EXPORT_SYMBOL(vbg_put_gdev); EXPORT_SYMBOL(vbg_put_gdev);
/** /*
* Callback for mouse events. * Callback for mouse events.
* *
* This is called at the end of the ISR, after leaving the event spinlock, if * This is called at the end of the ISR, after leaving the event spinlock, if
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment