History

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.

Mauro Carvalho Chehab committed 9 years ago

Commit 8db044b1 parent 3483d3a1 file · +14 −9Browse files

Unified · Split

drivers/media/dvb-core/dvb_demux.h+14−9
@@ -94,15 +94,20 @@ struct dvb_demux_filter { · 93 unmodified lines
9494 /**
9595 * struct dvb_demux_feed - describes a DVB field
9696 *
97− * @feed: a digital TV feed. It can either be a TS or a section feed:
98− * if the feed is TS, it contains &struct dvb_ts_feed @ts;
99− * if the feed is section, it contains
100− * &struct dmx_section_feed @sec.
101− * @cb: digital TV callbacks. depending on the feed type, it can be:
102− * if the feed is TS, it contains a dmx_ts_cb() @ts callback;
103− * if the feed is section, it contains a dmx_section_cb() @sec
104− * callback.
105− *
97+ * @feed: a union describing a digital TV feed.
98+ * Depending on the feed type, it can be either
99+ * @feed.ts or @feed.sec.
100+ * @feed.ts: a &struct dmx_ts_feed pointer.
101+ * For TS feed only.
102+ * @feed.sec: a &struct dmx_section_feed pointer.
103+ * For section feed only.
104+ * @cb: a union describing digital TV callbacks.
105+ * Depending on the feed type, it can be either
106+ * @cb.ts or @cb.sec.
107+ * @cb.ts: a dmx_ts_cb() calback function pointer.
108+ * For TS feed only.
109+ * @cb.sec: a dmx_section_cb() callback function pointer.
110+ * For section feed only.
106111 * @demux: pointer to &struct dvb_demux.
107112 * @priv: private data that can optionally be used by a DVB driver.
108113 * @type: type of the filter, as defined by &enum dvb_dmx_filter_type.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t