Messages in this thread | | | From | Linus Walleij <> | Date | Mon, 31 Jan 2022 12:24:53 +0100 | Subject | Re: [PATCH] gpio/consumer.h: don't use "/**" for non-kernel-doc comments |
| |
On Sun, Jan 30, 2022 at 8:31 AM Randy Dunlap <rdunlap@infradead.org> wrote:
> Use "/*" to begin non-kernel-doc comments instead of "/**", > which indicates the beginning of kernel-doc notation. > > Quietens these kernel-doc warnings: > > consumer.h:13: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are > consumer.h:13: warning: missing initial short description on line: > * Opaque descriptor for a GPIO. These are obtained using gpiod_get() and are > consumer.h:22: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Opaque descriptor for a structure of GPIO array attributes. This structure > consumer.h:22: warning: missing initial short description on line: > * Opaque descriptor for a structure of GPIO array attributes. This structure > consumer.h:30: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Struct containing an array of descriptors that can be obtained using > consumer.h:30: warning: missing initial short description on line: > * Struct containing an array of descriptors that can be obtained using > consumer.h:46: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * Optional flags that can be passed to one of gpiod_* to configure direction > consumer.h:46: warning: missing initial short description on line: > * Optional flags that can be passed to one of gpiod_* to configure direction > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Linus Walleij <linus.walleij@linaro.org> > Cc: Bartosz Golaszewski <brgl@bgdev.pl> > Cc: linux-gpio@vger.kernel.org
In this case the ambition was to provide proper kerneldoc for sure.
Is it possible to just fix the documentation?
Yours, Linus Walleij
| |