]> git.karo-electronics.de Git - karo-tx-linux.git/commit
doc-rst: fixed kernel-doc directives in usb/typec.rst
authorMarkus Heiser <markus.heiser@darmarit.de>
Sat, 13 May 2017 13:49:17 +0000 (15:49 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 17 May 2017 09:52:44 +0000 (11:52 +0200)
commit5383fae76b8224a8f0465be6ab9c7a645042951a
treef4b709fb6ad6e7bcf83b3117e000549b84246bd1
parentef53b92ece675ed9778b50f4432e004683696d01
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: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/usb/typec.rst