diff mbox series

PCI: Fix kernel-doc formatting

Message ID 20210702204917.1655556-1-kw@linux.com (mailing list archive)
State Superseded
Delegated to: Bjorn Helgaas
Headers show
Series PCI: Fix kernel-doc formatting | expand

Commit Message

Krzysztof Wilczyński July 2, 2021, 8:49 p.m. UTC 
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 <kw@linux.com>
---
 drivers/pci/pci.h | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/drivers/pci/pci.h b/drivers/pci/pci.h
index 37c913bbc6e1..e313e3a02c95 100644
--- a/drivers/pci/pci.h
+++ b/drivers/pci/pci.h
@@ -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)