iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

media: dvb_demux: describe nested structs

Browse Source 
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>
This commit is contained in:
Mauro Carvalho Chehab 2017-09-27 09:04:04 -04:00
parent 3483d3aebd
commit 8db044b24d
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
drivers/media/dvb-core/dvb_demux.h
View File

@ -94,15 +94,20 @@ struct dvb_demux_filter {
/** /**
* struct dvb_demux_feed - describes a DVB field * struct dvb_demux_feed - describes a DVB field
* *
* @feed: a digital TV feed. It can either be a TS or a section feed: * @feed: a union describing a digital TV feed.
* if the feed is TS, it contains &struct dvb_ts_feed @ts; * Depending on the feed type, it can be either
* if the feed is section, it contains * @feed.ts or @feed.sec.
* &struct dmx_section_feed @sec. * @feed.ts: a &struct dmx_ts_feed pointer.
* @cb: digital TV callbacks. depending on the feed type, it can be: * For TS feed only.
* if the feed is TS, it contains a dmx_ts_cb() @ts callback; * @feed.sec: a &struct dmx_section_feed pointer.
* if the feed is section, it contains a dmx_section_cb() @sec * For section feed only.
* callback. * @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. * @demux: pointer to &struct dvb_demux.
* @priv: private data that can optionally be used by a DVB driver. * @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. * @type: type of the filter, as defined by &enum dvb_dmx_filter_type.