Commit 58759874 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] doc-rst: Split v4l-core into one file per kAPI

Sphinx produce a 1:1 mapping between a rst file and an html file.

So, we need to split the kernel-doc tags on multiple documents.

A side effect is that we're now having a better name for each
section of the kAPI documentation.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 575f9308
V4L2 Async kAPI
^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-async.h
...@@ -807,3 +807,8 @@ notify function is called. ...@@ -807,3 +807,8 @@ notify function is called.
There can be only one notify function per control handler. Any attempt There can be only one notify function per control handler. Any attempt
to set another notify function will cause a WARN_ON. to set another notify function will cause a WARN_ON.
V4L2 control kAPI
-----------------
.. kernel-doc:: include/media/v4l2-ctrls.h
Video2Linux devices Video2Linux devices
------------------- -------------------
.. kernel-doc:: include/media/tuner.h .. toctree::
:maxdepth: 1
.. kernel-doc:: include/media/tuner-types.h
v4l2-framework
.. kernel-doc:: include/media/tveeprom.h v4l2-async
v4l2-controls
.. kernel-doc:: include/media/v4l2-async.h v4l2-device
v4l2-dv-timings
.. kernel-doc:: include/media/v4l2-ctrls.h v4l2-event
v4l2-flash-led-class
.. kernel-doc:: include/media/v4l2-device.h v4l2-mc
v4l2-mediabus
.. kernel-doc:: include/media/v4l2-dv-timings.h v4l2-mem2mem
v4l2-of
.. kernel-doc:: include/media/v4l2-event.h v4l2-rect
v4l2-subdev
.. kernel-doc:: include/media/v4l2-flash-led-class.h v4l2-tuner
v4l2-tveeprom
.. kernel-doc:: include/media/v4l2-mc.h v4l2-videobuf2
v4l2-videobuf
.. kernel-doc:: include/media/v4l2-mediabus.h
.. kernel-doc:: include/media/v4l2-mem2mem.h
.. kernel-doc:: include/media/v4l2-of.h
.. kernel-doc:: include/media/v4l2-rect.h
.. kernel-doc:: include/media/v4l2-subdev.h
.. kernel-doc:: include/media/videobuf2-core.h
.. kernel-doc:: include/media/videobuf2-v4l2.h
.. kernel-doc:: include/media/videobuf2-memops.h
V4L2 Device kAPI
^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-device.h
V4L2 DV Timings kAPI
^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-dv-timings.h
V4L2 event kAPI
^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-event.h
V4L2 Flash and LED class kAPI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-flash-led-class.h
V4L2 Media Controller kAPI
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-mc.h
V4L2 Media Bus kAPI
^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-mediabus.h
V4L2 Memory to Memory kAPI
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-mem2mem.h
V4L2 Open Firmware kAPI
^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-of.h
V4L2 rect kAPI
^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-rect.h
V4L2 subdev kAPI
^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-subdev.h
Tuner kAPI
^^^^^^^^^^
.. kernel-doc:: include/media/tuner.h
.. kernel-doc:: include/media/tuner-types.h
Hauppauge TV EEPROM kAPI
^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/tveeprom.h
V4L2 videobuf2 kAPI
^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/videobuf2-core.h
.. kernel-doc:: include/media/videobuf2-v4l2.h
.. kernel-doc:: include/media/videobuf2-memops.h
...@@ -28,9 +28,6 @@ For more details see the file COPYING in the source distribution of Linux. ...@@ -28,9 +28,6 @@ For more details see the file COPYING in the source distribution of Linux.
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:
kapi/v4l2-framework
kapi/v4l2-controls
kapi/videobuf
kapi/v4l2-core kapi/v4l2-core
kapi/dtv-core kapi/dtv-core
kapi/rc-core kapi/rc-core
......
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