[media] DocBook: finish documenting struct dmx_demux
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 6 Oct 2015 21:39:40 +0000 (18:39 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Tue, 6 Oct 2015 21:53:10 +0000 (18:53 -0300)
commit4bc645df7d46253836062ecb1e2969034d5ebd11
tree1fcea4c1c095b34ed7fcf77302317b2c842c38d1
parent1e92bbe08ad9fc0d5ec05174c176a9bc54921733
[media] DocBook: finish documenting struct dmx_demux

There are two callbacks still not documented:
.//drivers/media/dvb-core/demux.h:422: warning: No description found for parameter 'get_pes_pids'
.//drivers/media/dvb-core/demux.h:422: warning: No description found for parameter 'get_stc'

The purpose of first one is clear. The second one is used only
on the obsolete av7110 driver, and its purpose is not clear,
as it just returns a 64-bit word from the firmware to userspace.

Let's document get_pes_pids and mark get_stc as private, adding
a comment to not use it, while this is not documented.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
drivers/media/dvb-core/demux.h