[media] v4l2-event.h: fix comments and add to DocBook

The comments there are good enough for DocBook, however they're
using a wrong format. Fix and add to device-drivers.xml.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2015-08-22 08:28:39 -03:00
parent 7dc879190f
commit b6fce850d9
2 changed files with 26 additions and 23 deletions

View File

@ -232,9 +232,9 @@ X!Isound/sound_firmware.c
!Idrivers/media/dvb-core/dvb_math.h !Idrivers/media/dvb-core/dvb_math.h
!Idrivers/media/dvb-core/dvb_ringbuffer.h !Idrivers/media/dvb-core/dvb_ringbuffer.h
!Iinclude/media/v4l2-ctrls.h !Iinclude/media/v4l2-ctrls.h
!Iinclude/media/v4l2-event.h
<!-- FIXME: Removed for now due to document generation inconsistency <!-- FIXME: Removed for now due to document generation inconsistency
X!Iinclude/media/v4l2-dv-timings.h X!Iinclude/media/v4l2-dv-timings.h
X!Iinclude/media/v4l2-event.h
X!Iinclude/media/v4l2-mediabus.h X!Iinclude/media/v4l2-mediabus.h
X!Iinclude/media/videobuf2-memops.h X!Iinclude/media/videobuf2-memops.h
X!Iinclude/media/videobuf2-core.h X!Iinclude/media/videobuf2-core.h

View File

@ -68,7 +68,8 @@ struct v4l2_subdev;
struct v4l2_subscribed_event; struct v4l2_subscribed_event;
struct video_device; struct video_device;
/** struct v4l2_kevent - Internal kernel event struct. /**
* struct v4l2_kevent - Internal kernel event struct.
* @list: List node for the v4l2_fh->available list. * @list: List node for the v4l2_fh->available list.
* @sev: Pointer to parent v4l2_subscribed_event. * @sev: Pointer to parent v4l2_subscribed_event.
* @event: The event itself. * @event: The event itself.
@ -80,6 +81,7 @@ struct v4l2_kevent {
}; };
/** struct v4l2_subscribed_event_ops - Subscribed event operations. /** struct v4l2_subscribed_event_ops - Subscribed event operations.
*
* @add: Optional callback, called when a new listener is added * @add: Optional callback, called when a new listener is added
* @del: Optional callback, called when a listener stops listening * @del: Optional callback, called when a listener stops listening
* @replace: Optional callback that can replace event 'old' with event 'new'. * @replace: Optional callback that can replace event 'old' with event 'new'.
@ -92,7 +94,8 @@ struct v4l2_subscribed_event_ops {
void (*merge)(const struct v4l2_event *old, struct v4l2_event *new); void (*merge)(const struct v4l2_event *old, struct v4l2_event *new);
}; };
/** struct v4l2_subscribed_event - Internal struct representing a subscribed event. /**
* struct v4l2_subscribed_event - Internal struct representing a subscribed event.
* @list: List node for the v4l2_fh->subscribed list. * @list: List node for the v4l2_fh->subscribed list.
* @type: Event type. * @type: Event type.
* @id: Associated object ID (e.g. control ID). 0 if there isn't any. * @id: Associated object ID (e.g. control ID). 0 if there isn't any.