media: net.h: add kernel-doc and use it at Documentation/ (56d51b65) · Commits · 戴 / test

Documentation/media/uapi/dvb/net-add-if.rst

+0 −34

Original line number	Diff line number	Diff line
		@@ -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
		============

0 → 100644

+9 −0

Original line number	Diff line number	Diff line
		.. -- coding: utf-8; mode: rst --

		.. _dmx_types:

		**************
		Net Data Types
		**************

		.. kernel-doc:: include/uapi/linux/dvb/net.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -35,6 +35,7 @@ Digital TV net Function Calls
		.. toctree::
		:maxdepth: 1

		net-types
		net-add-if
		net-remove-if
		net-get-if

+15 −0

Original line number	Diff line number	Diff line
		@@ -26,6 +26,21 @@

		#include <linux/types.h>

		/**
		* struct dvb_net_if - describes a DVB network interface
		*
		* @pid: Packet ID (PID) of the MPEG-TS that contains data
		* @if_num: number of the Digital TV interface.
		* @feedtype: Encapsulation type of the feed.
		*
		* A MPEG-TS stream may contain packet IDs with IP packages on it.
		* This struct describes it, and the type of encoding.
		*
		* @feedtype can be:
		*
		* - %DVB_NET_FEEDTYPE_MPE for MPE encoding
		* - %DVB_NET_FEEDTYPE_ULE for ULE encoding.
		*/
		struct dvb_net_if {
		__u16 pid;
		__u16 if_num;