1
0
Fork 0
alistair23-linux/Documentation/media/kapi
Mauro Carvalho Chehab e383ce0736 [media] get rid of a number of problems at the cross references
As warned by linuxdoc[1] tool, using:

$ for i in $(git grep kernel-doc Documentation/media/kapi/|cut -d: -f4); do kernel-lintdoc --sloppy $i; done

    include/media/v4l2-dev.h:118 :WARN: function name from comment differs:  v4l2_prio_close <--> v4l2_prio_check
    include/media/v4l2-mc.h:56 [kernel-doc WARN] : enum name from comment differs:  if_vid_dec_index <--> if_vid_dec_pad_index
    include/media/v4l2-mc.h:71 [kernel-doc WARN] : enum name from comment differs:  if_aud_dec_index <--> if_aud_dec_pad_index
    include/media/v4l2-mem2mem.h:396 [kernel-doc WARN] : function name from comment differs:  v4l2_m2m_num_src_bufs_ready <--> v4l2_m2m_num_dst_bufs_ready
    drivers/media/dvb-core/dvb_math.h:28 [kernel-doc WARN] : function name from comment differs:  cintlog2 <--> intlog2
    include/media/v4l2-subdev.h:215 [kernel-doc WARN] : struct name from comment differs:  s_radio <--> v4l2_subdev_tuner_ops
    include/media/v4l2-subdev.h:890 [kernel-doc WARN] : function name from comment differs:  v4l2_set_subdevdata <--> v4l2_set_subdev_hostdata
    include/media/v4l2-subdev.h:901 [kernel-doc WARN] : function name from comment differs:  v4l2_get_subdevdata <--> v4l2_get_subdev_hostdata
    drivers/media/dvb-core/dvb_ringbuffer.h:196 [kernel-doc WARN] : function name from comment differs:  dvb_ringbuffer_writeuser <--> dvb_ringbuffer_write_user
    include/media/videobuf2-core.h:399 [kernel-doc WARN] : struct name from comment differs:  vb2_ops <--> vb2_buf_ops
    include/media/media-entity.h:132 [kernel-doc ERROR] : duplicate parameter definition 'source'
    include/media/media-entity.h:477 [kernel-doc WARN] : function name from comment differs:  media_entity_enum_test <--> media_entity_enum_test_and_set
    include/media/media-entity.h:535 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_pad
    include/media/media-entity.h:544 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_link
    include/media/media-entity.h:553 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> gobj_to_intf
    include/media/media-entity.h:562 [kernel-doc WARN] : function name from comment differs:  gobj_to_entity <--> intf_to_devnode
    include/media/rc-core.h:234 [kernel-doc WARN] : function name from comment differs:  rc_open <--> rc_close
    include/media/v4l2-ctrls.h:397 [kernel-doc WARN] : missing initial short description of 'v4l2_ctrl_handler_init'
    include/media/v4l2-dev.h:118 [kernel-doc WARN] : function name from comment differs:  v4l2_prio_close <--> v4l2_prio_check
    include/media/v4l2-event.h:225 [kernel-doc WARN] : missing initial short description of 'v4l2_src_change_event_subscribe'

[1] https://return42.github.io/linuxdoc/linux.html

The above are real issues at the documentation. On several cases,
caused by cut-and-paste.

 Fix them.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-22 10:00:23 -03:00
..
cec-core.rst [media] cec-core: Convert it to ReST format 2016-08-22 10:27:03 -03:00
dtv-core.rst [media] dtv-core.rst: move DTV ringbuffer notes to kAPI doc 2016-09-09 09:21:50 -03:00
mc-core.rst [media] docs-rst: simplify c:type: cross references 2016-09-09 09:54:54 -03:00
rc-core.rst [media] doc-rst: fix media kAPI documentation 2016-07-18 14:46:07 -03:00
v4l2-clocks.rst [media] move V4L2 clocks to a separate .rst file 2016-07-23 08:04:21 -03:00
v4l2-common.rst [media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_ops 2016-07-23 08:04:21 -03:00
v4l2-controls.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-core.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-dev.rst [media] get rid of a number of problems at the cross references 2016-09-22 10:00:23 -03:00
v4l2-device.rst [media] doc-rst: kapi: use :c:func: instead of :cpp:func 2016-07-23 08:04:21 -03:00
v4l2-dv-timings.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-event.rst [media] docs-rst: convert uAPI structs to C domain 2016-09-09 09:34:01 -03:00
v4l2-fh.rst [media] docs-next: stop abusing on the cpp domain 2016-08-22 21:23:00 -03:00
v4l2-flash-led-class.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-intro.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-mc.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-mediabus.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-mem2mem.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-of.rst [media] doc-rst: Split v4l-core into one file per kAPI 2016-07-23 08:03:24 -03:00
v4l2-rect.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-subdev.rst [media] v4l2-subdev.rst: get rid of legacy functions 2016-09-09 09:44:37 -03:00
v4l2-tuner.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-tveeprom.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-videobuf.rst [media] v4l2-dev: add cross-references and improve markup 2016-07-23 08:04:21 -03:00
v4l2-videobuf2.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00