diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-09-27 09:04:04 -0400 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-12-18 09:05:04 -0500 |
| commit | 8db044b24db8ffec0c81c218e31f72aacfd34f3d (patch) | |
| tree | 87acfdff668171bfbcd443fd24f267ce6528aa4e /drivers/media | |
| parent | 3483d3aebdf48bf097b90525027ee309d33a1267 (diff) | |
media: dvb_demux: describe nested structs
There are some nested structs on this header, with aren't
properly document them.
This should solve some warnings after the addition of
a patche at kernel-doc adding support for nested structs/unions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'drivers/media')
| -rw-r--r-- | drivers/media/dvb-core/dvb_demux.h | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/drivers/media/dvb-core/dvb_demux.h b/drivers/media/dvb-core/dvb_demux.h index cc048f09aa85..c3bcdeed06c4 100644 --- a/drivers/media/dvb-core/dvb_demux.h +++ b/drivers/media/dvb-core/dvb_demux.h @@ -94,15 +94,20 @@ struct dvb_demux_filter { /** * struct dvb_demux_feed - describes a DVB field * - * @feed: a digital TV feed. It can either be a TS or a section feed: - * if the feed is TS, it contains &struct dvb_ts_feed @ts; - * if the feed is section, it contains - * &struct dmx_section_feed @sec. - * @cb: digital TV callbacks. depending on the feed type, it can be: - * if the feed is TS, it contains a dmx_ts_cb() @ts callback; - * if the feed is section, it contains a dmx_section_cb() @sec - * callback. - * + * @feed: a union describing a digital TV feed. + * Depending on the feed type, it can be either + * @feed.ts or @feed.sec. + * @feed.ts: a &struct dmx_ts_feed pointer. + * For TS feed only. + * @feed.sec: a &struct dmx_section_feed pointer. + * For section feed only. + * @cb: a union describing digital TV callbacks. + * Depending on the feed type, it can be either + * @cb.ts or @cb.sec. + * @cb.ts: a dmx_ts_cb() calback function pointer. + * For TS feed only. + * @cb.sec: a dmx_section_cb() callback function pointer. + * For section feed only. * @demux: pointer to &struct dvb_demux. * @priv: private data that can optionally be used by a DVB driver. * @type: type of the filter, as defined by &enum dvb_dmx_filter_type. |