PCI: Fix kernel-doc formatting
PATCH 1/1 PCI: Fix kernel-doc formatting
Fix kernel-doc formatting of function pci_dev_set_io_state(), and resolve build time warnings related to kernel-doc:
drivers/pci/pci.h:337: warning: Function parameter or member 'dev' not described in 'pci_dev_set_io_state' drivers/pci/pci.h:337: warning: Function parameter or member 'new' not described in 'pci_dev_set_io_state'
No change to functionality intended.
Signed-off-by Krzysztof Wilczyński <[email protected]>
--- drivers/pci/pci.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-)
drivers/pci/pci.h +5 -4
@@ -323,13 +323,14 @@ struct pci_sriov {/** * pci_dev_set_io_state - Set the new error state if possible. -* -* @dev - pci device to set new error_state -* @new - the state we want dev to be in +* @dev: PCI device to set new error_state. +* @new: The state we want dev to be in. * * Must be called with device_lock held. * -* Returns true if state has been changed to the requested state. +* Return: +* * true - On success, current state has been changed to the requested state. +* * false - On failure, current state has not been changed. */ static inline bool pci_dev_set_io_state (struct pci_dev *dev,pci_channel_state_t new)
Signature · 1 line
2.32.0