Commit 5383fae7 authored by Markus Heiser's avatar Markus Heiser Committed by Greg Kroah-Hartman

doc-rst: fixed kernel-doc directives in usb/typec.rst

Even if this file is not yet included in any toctree, it is parsed by
Sphinx since it is named '.rst'. This patch fixes the following two
ERRORs from Sphinx build:

Documentation/usb/typec.rst:116: ERROR: Error in "kernel-doc" directive:
invalid option block.

.. kernel-doc:: drivers/usb/typec/typec.c
   :functions: typec_register_cable typec_unregister_cable typec_register_plug
   typec_unregister_plug

Documentation/usb/typec.rst:139: ERROR: Error in "kernel-doc" directive:
invalid option block.

.. kernel-doc:: drivers/usb/typec/typec.c
   :functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role
   typec_set_pwr_opmode
Signed-off-by: default avatarMarkus Heiser <markus.heiser@darmarit.de>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ef53b92e
...@@ -114,8 +114,7 @@ the details during registration. The class offers the following API for ...@@ -114,8 +114,7 @@ the details during registration. The class offers the following API for
registering/unregistering cables and their plugs: registering/unregistering cables and their plugs:
.. kernel-doc:: drivers/usb/typec/typec.c .. kernel-doc:: drivers/usb/typec/typec.c
:functions: typec_register_cable typec_unregister_cable typec_register_plug :functions: typec_register_cable typec_unregister_cable typec_register_plug typec_unregister_plug
typec_unregister_plug
The class will provide a handle to struct typec_cable and struct typec_plug if The class will provide a handle to struct typec_cable and struct typec_plug if
the registration is successful, or NULL if it isn't. the registration is successful, or NULL if it isn't.
...@@ -137,8 +136,7 @@ during connection of a partner or cable, the port driver must use the following ...@@ -137,8 +136,7 @@ during connection of a partner or cable, the port driver must use the following
APIs to report it to the class: APIs to report it to the class:
.. kernel-doc:: drivers/usb/typec/typec.c .. kernel-doc:: drivers/usb/typec/typec.c
:functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role :functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role typec_set_pwr_opmode
typec_set_pwr_opmode
Alternate Modes Alternate Modes
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment