tty: add kernel-doc for tty_operations
authorJiri Slaby <jslaby@suse.cz>
Fri, 26 Nov 2021 08:15:52 +0000 (09:15 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 26 Nov 2021 15:27:42 +0000 (16:27 +0100)
commit1fe183091753b1d7f11e70593700c0c0ef268db7
tree6bdcc2aabbe353b75c10edc05f821b48f35e90b2
parenta6563830215226aae0e7e6802955c77a6a7b7547
tty: add kernel-doc for tty_operations

tty_operations structure was already documented in a standalone comment
in the header beginning.

Move it right before the structure and reformat it so it complies to
kernel-doc. That way, we can include it in Documentation/ later in this
series.

Note that we named proc_show's parameters, so that we can reference
them in the text.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-5-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/tty_driver.h