Searched hist:cb6f6f9877928f6c3373f0b2088f05cda56344c5 (Results 1 – 1 of 1) sorted by relevance
| /openbmc/linux/drivers/tty/ |
| H A D | tty_port.c | diff cb6f6f9877928f6c3373f0b2088f05cda56344c5 Fri Nov 26 02:15:59 CST 2021 Jiri Slaby <jslaby@suse.cz> tty: reformat kernel-doc in tty_port.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. 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) Use recognized "Note" instead of "NB" (nota bene).
5) 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-12-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
|