usb: docs: document altmode register/unregister functions
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 10 Sep 2020 07:25:14 +0000 (09:25 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 15 Oct 2020 05:49:48 +0000 (07:49 +0200)
commit1b7743912bcf2b4a9d9c96de668542156450554f
tree6bea374052e16b24686b6cfc5b12e191db864531
parent623050ae373162a65973f62c128eabe3ec288c4d
usb: docs: document altmode register/unregister functions

The typec_bus.rst asks for documentation of those two
functions, but they don't exist:

./drivers/usb/typec/bus.c:1: warning: 'typec_altmode_unregister_driver' not found
./drivers/usb/typec/bus.c:1: warning: 'typec_altmode_register_driver' not found

Also, they're not declared on bus.c but, instead, at a header
file (typec_altmode.h).

So, add documentation for both functions at the header and
change the kernel-doc markup under typec_bus.rst to point
to the right place.

While here, also place the documentation for both structs
declared on typec_altmode.h at the rst file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Documentation/driver-api/usb/typec_bus.rst
include/linux/usb/typec_altmode.h