Documentation: serial: move uart_ops documentation to the struct
authorJiri Slaby <jslaby@suse.cz>
Thu, 28 Jul 2022 06:10:51 +0000 (08:10 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 28 Jul 2022 08:37:42 +0000 (10:37 +0200)
commite60a7233684aa8bbe9090537720fe6a1e901d823
tree9fada5a43fe45090daf223659b0df576fc1e2763
parent0f42d7f23fd9be143de73eb040c2806a75db8853
Documentation: serial: move uart_ops documentation to the struct

While it's a lot of text, it always helps to keep it up to date when
it's by the source. (And not in a separate file.)

The documentation tooling also makes sure that all members of the
structure are documented. (If not, it complains loudly.)

Finally, there needs to be no comments inlined in the structure, so they
are dropped as they are superfluous now.

The compilation time of this header (tested with serial_core.c) didn't
change in my testing at all.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20220728061056.20799-1-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/driver-api/serial/driver.rst
include/linux/serial_core.h