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

media: dmxdev: 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-26 16:46:16 -04:00
parent 45267fed3e
commit 3483d3aebd
1 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
drivers/media/dvb-core/dmxdev.h
View File

@ -89,19 +89,24 @@ struct dmxdev_feed {
/** /**
* struct dmxdev_filter - digital TV dmxdev filter * struct dmxdev_filter - digital TV dmxdev filter
* *
* @filter: a dmxdev filter. Currently used only for section filter: * @filter: a union describing a dmxdev filter.
* if the filter is Section, it contains a * Currently used only for section filters.
* &struct dmx_section_filter @sec pointer. * @filter.sec: a &struct dmx_section_filter pointer.
* @feed: a dmxdev feed. Depending on the feed type, it can be: * For section filter only.
* for TS feed: a &struct list_head @ts list of TS and PES * @feed: a union describing a dmxdev feed.
* feeds; * Depending on the filter type, it can be either
* for section feed: a &struct dmx_section_feed @sec pointer. * @feed.ts or @feed.sec.
* @params: dmxdev filter parameters. Depending on the feed type, it * @feed.ts: a &struct list_head list.
* can be: * For TS and PES feeds.
* for section filter: a &struct dmx_sct_filter_params @sec * @feed.sec: a &struct dmx_section_feed pointer.
* embedded struct; * For section feed only.
* for a TS filter: a &struct dmx_pes_filter_params @pes * @params: a union describing dmxdev filter parameters.
* embedded struct. * Depending on the filter type, it can be either
* @params.sec or @params.pes.
* @params.sec: a &struct dmx_sct_filter_params embedded struct.
* For section filter only.
* @params.pes: a &struct dmx_pes_filter_params embedded struct.
* For PES filter only.
* @type: type of the dmxdev filter, as defined by &enum dmxdev_type. * @type: type of the dmxdev filter, as defined by &enum dmxdev_type.
* @state: state of the dmxdev filter, as defined by &enum dmxdev_state. * @state: state of the dmxdev filter, as defined by &enum dmxdev_state.
* @dev: pointer to &struct dmxdev. * @dev: pointer to &struct dmxdev.