[media] doc-rst: Fix conversion for v4l2 core functions

Browse source

The conversion from DocBook lead into some conversion issues,
basically due to the lack of proper support at kernel-doc.

So, address them:

- 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.

- kernel-doc doesn't escape things like *pointer, so we
  need to manually add a escape char before it.

- On some cases, kernel-doc conversion requires violating
  the 80-cols, as otherwise it won't properly parse the
  source code.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

...

This commit is contained in:

Mauro Carvalho Chehab 2016-07-17 08:44:08 -03:00

parent 5b6137dc84

commit 89cb3ddbe7

6 changed files with 70 additions and 24 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

8

include/media/tuner-types.h

View file

18

include/media/tveeprom.h

View file

13

include/media/v4l2-mc.h

View file

4

include/media/v4l2-subdev.h

View file

30

include/media/videobuf2-core.h

View file