summaryrefslogtreecommitdiffstats
path: root/Documentation/media/kapi/mc-core.rst
AgeCommit message (Collapse)AuthorFilesLines
2016-07-23[media] doc-rst: kapi: use :c:func: instead of :cpp:funcMauro Carvalho Chehab1-25/+25
References at the rst files for C functions generated via kernel-doc should use :c:func:. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] mc-core: Fix a cross-referenceMauro Carvalho Chehab1-1/+1
The v4l2_subdev reference was using the wrong tag. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-23[media] doc-rst: better organize the media booksMauro Carvalho Chehab1-1/+1
The uAPI book has 5 parts, but they lost numeration after conversion to rst. Manually number those parts, and make the main index with 1 depth, to only show the parts and the annexes. At each part, use :maxwidth: 5, in order to show a more complete index. While here, fix the cross-references between different books. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-18[media] doc-rst: fix media kAPI documentationMauro Carvalho Chehab1-8/+0
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-17[media] doc-rst: Fix conversion for MC core functionsMauro Carvalho Chehab1-81/+105
There were lots of issues at the media controller side, after the conversion: - Some documentation at the header files weren't using the kernel-doc start block; - Now, the C files with the exported symbols also need to be added. So, all headers need to be included twice: one to get the structs/enums/.. and another one for the functions; - Notes should use the ReST tag, as kernel-doc doesn't recognizes it anymore; - Identation needs to be fixed, as ReST uses it to identify when a format "tag" ends. - Fix the cross-references at the media controller description. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17[media] doc-rst: split media_drivers.rst into one file per API typeMauro Carvalho Chehab1-0/+247
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>