tty: reformat kernel-doc in tty_io.c
authorJiri Slaby <jslaby@suse.cz>
Fri, 26 Nov 2021 08:16:00 +0000 (09:16 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 26 Nov 2021 15:27:43 +0000 (16:27 +0100)
commit796a75a98762f14006d2f941163b589f7ebcdf87
treec81aeddbc6f22ce03ed217eb4c074129597c18c8
parentcb6f6f9877928f6c3373f0b2088f05cda56344c5
tty: reformat kernel-doc in tty_io.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.

By the above, this patch also unifies these docs with the other
kernel-doc's in this file.

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