driver core: platform: Document return type of more functions
authorStephen Boyd <swboyd@chromium.org>
Thu, 10 Sep 2020 06:04:40 +0000 (23:04 -0700)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 10 Sep 2020 16:30:01 +0000 (18:30 +0200)
commit0c7a6b91d2276b09ade6e09766600f809f5a529a
tree38f3a0e8569719da8482b1033455da9e7d9fc654
parentf601e8f37c2c1c52f2923fffc48204a7f7dc023d
driver core: platform: Document return type of more functions

I can't always remember the return values of these functions, and so I
usually jump to the function to read the kernel-doc and see that it
doesn't tell me. Then I have to spend more time reading the code to jump
to the function that actually tells me the return values. Let's document
it here so that we don't all have to spend time digging through the code
to understand the return values.

Cc: <linux-doc@vger.kernel.org>
Signed-off-by: Stephen Boyd <swboyd@chromium.org>
Link: https://lore.kernel.org/r/20200910060440.2302925-1-swboyd@chromium.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/base/platform.c
lib/devres.c