PM: runtime: Add kerneldoc comments to multiple helpers
authorRafael J. Wysocki <rafael.j.wysocki@intel.com>
Fri, 31 Jul 2020 17:03:26 +0000 (19:03 +0200)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Tue, 4 Aug 2020 10:39:28 +0000 (12:39 +0200)
commit403d2d116ec011942a8505068b943c5c6cd91176
tree236e80e22e1969b10b604929a57b698e4fda3565
parent04084978003c1a1810a0b1fea581078106394a32
PM: runtime: Add kerneldoc comments to multiple helpers

Add kerneldoc comments to multiple PM-runtime helper functions
defined as static inline wrappers around lower-level routines to
provide quick reference decumentation of their behavior.

Some of them are similar to each other with subtle differences only
and the behavior of some of them may appear as counter-intuitive, so
clarify all that to avoid confusion.

Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Acked-by: Alan Stern <stern@rowland.harvard.edu>
Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>
include/linux/pm_runtime.h