openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
linux/Documentation/media/kapi/rc-core.rst

15 lines
233 B
ReStructuredText
Raw Normal View History

[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 19:22:23 +08:00
Remote Controller devices
-------------------------
[media] doc-rst: Fix issues with RC documentation The kernel-doc script is now broken if it doesn't find all exported symbols documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 20:16:57 +08:00
Remote Controller core
~~~~~~~~~~~~~~~~~~~~~~
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 19:22:23 +08:00
.. kernel-doc:: include/media/rc-core.h
[media] doc-rst: fix media kAPI documentation I ended by adding twice each media header, because I saw some missing stuff at the documents. It seems it was my mistake, as everything seems to be there. So, remove those extra stuff, to avoid duplicating the documentation of the functions. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-19 01:46:07 +08:00
.. kernel-doc:: include/media/rc-map.h
[media] doc-rst: Fix issues with RC documentation The kernel-doc script is now broken if it doesn't find all exported symbols documented. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 20:16:57 +08:00
LIRC
~~~~
[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 19:22:23 +08:00
.. kernel-doc:: include/media/lirc_dev.h