tty: add kernel-doc for tty_port
authorJiri Slaby <jslaby@suse.cz>
Fri, 26 Nov 2021 08:15:50 +0000 (09:15 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 26 Nov 2021 15:27:42 +0000 (16:27 +0100)
commit61c83addb77c65f498a8db0e7113dc3acf753c45
treedeae700536131de001a524bafd4d7940456bfce4
parent18e6c0751cf9ae0631a2623e31af2bf504f72c30
tty: add kernel-doc for tty_port

tty_port used to have only short comments along its members. Convert
them into proper kernel-doc comments in front of the structure. And add
some more explanation to them where needed.

The whole structure purpose and handling is documented at the end too --
some pieces of preexisting text moved to this place.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-3-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/linux/tty_port.h