]> Git Repo - linux.git/commit - drivers/tty/n_tty.c
tty: reformat kernel-doc in n_tty.c
authorJiri Slaby <[email protected]>
Fri, 26 Nov 2021 08:16:04 +0000 (09:16 +0100)
committerGreg Kroah-Hartman <[email protected]>
Fri, 26 Nov 2021 15:27:43 +0000 (16:27 +0100)
commit98629663bff8c2831f9cfd2b4e67537b24a48daa
tree766d52eda4b6ed58487d99a042c528684a9a8427
parentc66453ce8af8bac78a72ba4e21fd9a86720127d7
tty: reformat kernel-doc in n_tty.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 <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Greg Kroah-Hartman <[email protected]>
drivers/tty/n_tty.c
This page took 0.052711 seconds and 4 git commands to generate.