[3/3] drivers: Fix htmldocs warnings with bus_find_next_device()
diff mbox series

Message ID 20190801102026.27312-3-suzuki.poulose@arm.com
State In Next
Commit 313b46d831189f593840c625d7972092cb0088fc
Headers show
Series
  • [1/3] i2c: Revert incorrect conversion to use generic helper
Related show

Commit Message

Suzuki K Poulose Aug. 1, 2019, 10:20 a.m. UTC
Document the parameters for bus_find_next_device() to avoid
htmldocs build warnings as reported below :

include/linux/device.h:236: warning: Function parameter or member 'bus' not described in 'bus_find_next_device'
include/linux/device.h:236: warning: Function parameter or member 'cur' not described in 'bus_find_next_device'

Reported-by: kbuild test robot <lkp@intel.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com>
---
 include/linux/device.h | 2 ++
 1 file changed, 2 insertions(+)

Patch
diff mbox series

diff --git a/include/linux/device.h b/include/linux/device.h
index b17548b94c3e..ea0238c73a9c 100644
--- a/include/linux/device.h
+++ b/include/linux/device.h
@@ -229,6 +229,8 @@  static inline struct device *bus_find_device_by_devt(struct bus_type *bus,
 /**
  * bus_find_next_device - Find the next device after a given device in a
  * given bus.
+ * @bus: bus type
+ * @cur: device to begin the search with.
  */
 static inline struct device *
 bus_find_next_device(struct bus_type *bus,struct device *cur)