diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-23 10:21:06 (GMT) |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-23 11:04:21 (GMT) |
commit | 7b998bae0546d7b1d9bcf0e23c4b3294c4027e4c (patch) | |
tree | f65f7c770777b6ca16a28602ff8477f213e69ea1 /Documentation/media/kapi/v4l2-event.rst | |
parent | a3f57ad0e401cc19887da462b16a20d97e7bccfb (diff) | |
download | linux-7b998bae0546d7b1d9bcf0e23c4b3294c4027e4c.tar.xz |
[media] doc-rst: kapi: use :c:func: instead of :cpp:func
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>
Diffstat (limited to 'Documentation/media/kapi/v4l2-event.rst')
-rw-r--r-- | Documentation/media/kapi/v4l2-event.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/media/kapi/v4l2-event.rst b/Documentation/media/kapi/v4l2-event.rst index d81bbf2..f962686 100644 --- a/Documentation/media/kapi/v4l2-event.rst +++ b/Documentation/media/kapi/v4l2-event.rst @@ -39,7 +39,7 @@ A good example of these ``replace``/``merge`` callbacks is in v4l2-event.c: In order to queue events to video device, drivers should call: - :cpp:func:`v4l2_event_queue <v4l2_event_queue>` + :c:func:`v4l2_event_queue <v4l2_event_queue>` (:c:type:`vdev <video_device>`, :ref:`ev <v4l2-event>`) The driver's only responsibility is to fill in the type and the data fields. @@ -50,7 +50,7 @@ Event subscription Subscribing to an event is via: - :cpp:func:`v4l2_event_subscribe <v4l2_event_subscribe>` + :c:func:`v4l2_event_subscribe <v4l2_event_subscribe>` (:c:type:`fh <v4l2_fh>`, :ref:`sub <v4l2-event-subscription>` , elems, :c:type:`ops <v4l2_subscribed_event_ops>`) @@ -59,7 +59,7 @@ This function is used to implement :c:type:`video_device`-> :c:type:`ioctl_ops <v4l2_ioctl_ops>`-> ``vidioc_subscribe_event``, but the driver must check first if the driver is able to produce events with specified event id, and then should call -:cpp:func:`v4l2_event_subscribe` to subscribe the event. +:c:func:`v4l2_event_subscribe` to subscribe the event. The elems argument is the size of the event queue for this event. If it is 0, then the framework will fill in a default value (this depends on the event @@ -85,12 +85,12 @@ Unsubscribing an event Unsubscribing to an event is via: - :cpp:func:`v4l2_event_unsubscribe <v4l2_event_unsubscribe>` + :c:func:`v4l2_event_unsubscribe <v4l2_event_unsubscribe>` (:c:type:`fh <v4l2_fh>`, :ref:`sub <v4l2-event-subscription>`) This function is used to implement :c:type:`video_device`-> :c:type:`ioctl_ops <v4l2_ioctl_ops>`-> ``vidioc_unsubscribe_event``. -A driver may call :cpp:func:`v4l2_event_unsubscribe` directly unless it +A driver may call :c:func:`v4l2_event_unsubscribe` directly unless it wants to be involved in unsubscription process. The special type ``V4L2_EVENT_ALL`` may be used to unsubscribe all events. The @@ -101,7 +101,7 @@ Check if there's a pending event Checking if there's a pending event is via: - :cpp:func:`v4l2_event_pending <v4l2_event_pending>` + :c:func:`v4l2_event_pending <v4l2_event_pending>` (:c:type:`fh <v4l2_fh>`) |