tty: reformat kernel-doc in tty_ldisc.c
authorJiri Slaby <jslaby@suse.cz>
Fri, 26 Nov 2021 08:16:01 +0000 (09:16 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 26 Nov 2021 15:27:43 +0000 (16:27 +0100)
commitcbb68f91995001c79a9b89dcf6a25d22c7b92872
treeb9763a70fd7add239612ba22e75e3e1b101034c4
parent796a75a98762f14006d2f941163b589f7ebcdf87
tty: reformat kernel-doc in tty_ldisc.c

Kernel-doc is a bit strict about some formatting. So fix these:
1) When there is a tab in comments, it thinks the line is a continuation
   one. So the description of the functions end up as descriptions of
   the last parameter described. Remove the tabs.

2) Remove newlines before parameters description and after the comments.
   This was not wrong per se, only inconsistent with the rest of the
   file.

3) Add periods to the end of sentences where appropriate.

4) Add "()" to function names and "%" to constants, so that they are
   properly highlighted.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-14-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/tty/tty_ldisc.c