gpiolib: make struct comments into real kernel docs
authorBartosz Golaszewski <brgl@bgdev.pl>
Tue, 8 Feb 2022 10:48:31 +0000 (11:48 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sat, 31 Dec 2022 12:14:30 +0000 (13:14 +0100)
commit333a271dfd6b91bbf9b620c86ee1dcec667b4566
treea90c15fdc822a4de31d025ebf11fb06fc9b94cc3
parent7c755a2d6df511eeb5afba966ac28140f9ea5063
gpiolib: make struct comments into real kernel docs

[ Upstream commit 4398693a9e24bcab0b99ea219073917991d0792b ]

We have several comments that start with '/**' but don't conform to the
kernel doc standard. Add proper detailed descriptions for the affected
definitions and move the docs from the forward declarations to the
struct definitions where applicable.

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Stable-dep-of: bdbbae241a04 ("gpiolib: protect the GPIO device against being dropped while in use by user-space")
Signed-off-by: Sasha Levin <sashal@kernel.org>
drivers/gpio/gpiolib.h
include/linux/gpio/consumer.h