media: net.h: add kernel-doc and use it at Documentation/

As we did with frontend.h, ca.h and dmx.h, move the struct
definition to net.h.

That should help to keep it updated, as more stuff gets
added there.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
This commit is contained in:
Mauro Carvalho Chehab 2017-09-01 15:45:47 -04:00
commit 56d51b65bc
4 changed files with 25 additions and 34 deletions

View file

@ -41,40 +41,6 @@ created.
The struct :c:type:`dvb_net_if`::ifnum field will be
filled with the number of the created interface.
.. c:type:: dvb_net_if
.. flat-table:: struct dvb_net_if
:header-rows: 1
:stub-columns: 0
- .. row 1
- ID
- Description
- .. row 2
- pid
- Packet ID (PID) of the MPEG-TS that contains data
- .. row 3
- ifnum
- number of the Digital TV interface.
- .. row 4
- feedtype
- Encapsulation type of the feed. It can be:
``DVB_NET_FEEDTYPE_MPE`` for MPE encoding or
``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
Return Value
============

View file

@ -0,0 +1,9 @@
.. -*- coding: utf-8; mode: rst -*-
.. _dmx_types:
**************
Net Data Types
**************
.. kernel-doc:: include/uapi/linux/dvb/net.h

View file

@ -35,6 +35,7 @@ Digital TV net Function Calls
.. toctree::
:maxdepth: 1
net-types
net-add-if
net-remove-if
net-get-if