[media] docs-rst: convert uAPI structs to C domain
instead of declaring the uAPI structs using usual refs, e. g.: .. _foo-struct: Use the C domain way: .. c:type:: foo_struct This way, the kAPI documentation can use cross-references to point to the uAPI symbols. That solves about ~100 undefined warnings like: WARNING: c:type reference target not found: foo_struct Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
@@ -71,7 +71,7 @@ the following values.
|
||||
} audio_channel_select_t;
|
||||
|
||||
|
||||
.. _audio-status:
|
||||
.. c:type:: audio_status
|
||||
|
||||
struct audio_status
|
||||
===================
|
||||
@@ -93,7 +93,7 @@ about various states of the playback operation.
|
||||
} audio_status_t;
|
||||
|
||||
|
||||
.. _audio-mixer:
|
||||
.. c:type:: audio_mixer
|
||||
|
||||
struct audio_mixer
|
||||
==================
|
||||
@@ -132,7 +132,7 @@ following bits set according to the hardwares capabilities.
|
||||
#define AUDIO_CAP_AC3 256
|
||||
|
||||
|
||||
.. _audio-karaoke:
|
||||
.. c:type:: audio_karaoke
|
||||
|
||||
struct audio_karaoke
|
||||
====================
|
||||
|
@@ -7,7 +7,7 @@ CA Data Types
|
||||
*************
|
||||
|
||||
|
||||
.. _ca-slot-info:
|
||||
.. c:type:: ca_slot_info
|
||||
|
||||
ca_slot_info_t
|
||||
==============
|
||||
@@ -31,7 +31,7 @@ ca_slot_info_t
|
||||
} ca_slot_info_t;
|
||||
|
||||
|
||||
.. _ca-descr-info:
|
||||
.. c:type:: ca_descr_info
|
||||
|
||||
ca_descr_info_t
|
||||
===============
|
||||
@@ -48,7 +48,7 @@ ca_descr_info_t
|
||||
} ca_descr_info_t;
|
||||
|
||||
|
||||
.. _ca-caps:
|
||||
.. c:type:: ca_caps
|
||||
|
||||
ca_caps_t
|
||||
=========
|
||||
@@ -64,7 +64,7 @@ ca_caps_t
|
||||
} ca_cap_t;
|
||||
|
||||
|
||||
.. _ca-msg:
|
||||
.. c:type:: ca_msg
|
||||
|
||||
ca_msg_t
|
||||
========
|
||||
@@ -81,7 +81,7 @@ ca_msg_t
|
||||
} ca_msg_t;
|
||||
|
||||
|
||||
.. _ca-descr:
|
||||
.. c:type:: ca_descr
|
||||
|
||||
ca_descr_t
|
||||
==========
|
||||
@@ -96,7 +96,7 @@ ca_descr_t
|
||||
} ca_descr_t;
|
||||
|
||||
|
||||
.. _ca-pid:
|
||||
.. c:type:: ca_pid
|
||||
|
||||
ca-pid
|
||||
======
|
||||
|
@@ -120,7 +120,7 @@ dmx_pes_type_t
|
||||
} dmx_pes_type_t;
|
||||
|
||||
|
||||
.. _dmx-filter:
|
||||
.. c:type:: dmx_filter
|
||||
|
||||
struct dmx_filter
|
||||
=================
|
||||
@@ -136,7 +136,7 @@ struct dmx_filter
|
||||
} dmx_filter_t;
|
||||
|
||||
|
||||
.. _dmx-sct-filter-params:
|
||||
.. c:type:: dmx_sct_filter_params
|
||||
|
||||
struct dmx_sct_filter_params
|
||||
============================
|
||||
@@ -157,7 +157,7 @@ struct dmx_sct_filter_params
|
||||
};
|
||||
|
||||
|
||||
.. _dmx-pes-filter-params:
|
||||
.. c:type:: dmx_pes_filter_params
|
||||
|
||||
struct dmx_pes_filter_params
|
||||
============================
|
||||
@@ -194,7 +194,7 @@ struct dmx_event
|
||||
};
|
||||
|
||||
|
||||
.. _dmx-stc:
|
||||
.. c:type:: dmx_stc
|
||||
|
||||
struct dmx_stc
|
||||
==============
|
||||
@@ -209,7 +209,7 @@ struct dmx_stc
|
||||
};
|
||||
|
||||
|
||||
.. _dmx-caps:
|
||||
.. c:type:: dmx_caps
|
||||
|
||||
struct dmx_caps
|
||||
===============
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _dtv-fe-stats:
|
||||
.. c:type:: dtv_fe_stats
|
||||
|
||||
*******************
|
||||
struct dtv_fe_stats
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _dtv-properties:
|
||||
.. c:type:: dtv_properties
|
||||
|
||||
*********************
|
||||
struct dtv_properties
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _dtv-property:
|
||||
.. c:type:: dtv_property
|
||||
|
||||
*******************
|
||||
struct dtv_property
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _dtv-stats:
|
||||
.. c:type:: dtv_stats
|
||||
|
||||
****************
|
||||
struct dtv_stats
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _dvb-frontend-event:
|
||||
.. c:type:: dvb_frontend_event
|
||||
|
||||
***************
|
||||
frontend events
|
||||
|
@@ -1,6 +1,6 @@
|
||||
.. -*- coding: utf-8; mode: rst -*-
|
||||
|
||||
.. _dvb-frontend-parameters:
|
||||
.. c:type:: dvb_frontend_parameters
|
||||
|
||||
*******************
|
||||
frontend parameters
|
||||
@@ -49,7 +49,7 @@ frontends the ``frequency`` specifies the absolute frequency and is
|
||||
given in Hz.
|
||||
|
||||
|
||||
.. _dvb-qpsk-parameters:
|
||||
.. c:type:: dvb_qpsk_parameters
|
||||
|
||||
QPSK parameters
|
||||
===============
|
||||
@@ -66,7 +66,7 @@ structure:
|
||||
};
|
||||
|
||||
|
||||
.. _dvb-qam-parameters:
|
||||
.. c:type:: dvb_qam_parameters
|
||||
|
||||
QAM parameters
|
||||
==============
|
||||
@@ -83,7 +83,7 @@ for cable QAM frontend you use the ``dvb_qam_parameters`` structure:
|
||||
};
|
||||
|
||||
|
||||
.. _dvb-vsb-parameters:
|
||||
.. c:type:: dvb_vsb_parameters
|
||||
|
||||
VSB parameters
|
||||
==============
|
||||
@@ -98,7 +98,7 @@ ATSC frontends are supported by the ``dvb_vsb_parameters`` structure:
|
||||
};
|
||||
|
||||
|
||||
.. _dvb-ofdm-parameters:
|
||||
.. c:type:: dvb_ofdm_parameters
|
||||
|
||||
OFDM parameters
|
||||
===============
|
||||
|
@@ -23,7 +23,7 @@ union/struct based approach, in favor of a properties set approach.
|
||||
.. note::
|
||||
|
||||
On Linux DVB API version 3, setting a frontend were done via
|
||||
:ref:`struct dvb_frontend_parameters <dvb-frontend-parameters>`.
|
||||
:c:type:`struct dvb_frontend_parameters <dvb_frontend_parameters>`.
|
||||
This got replaced on version 5 (also called "S2API", as this API were
|
||||
added originally_enabled to provide support for DVB-S2), because the
|
||||
old API has a very limited support to new standards and new hardware.
|
||||
|
@@ -27,7 +27,7 @@ Arguments
|
||||
|
||||
``argp``
|
||||
pointer to struct
|
||||
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
|
||||
:c:type:`dvb_diseqc_slave_reply`
|
||||
|
||||
|
||||
Description
|
||||
@@ -35,7 +35,7 @@ Description
|
||||
|
||||
Receives reply from a DiSEqC 2.0 command.
|
||||
|
||||
.. _dvb-diseqc-slave-reply:
|
||||
.. c:type:: dvb_diseqc_slave_reply
|
||||
|
||||
struct dvb_diseqc_slave_reply
|
||||
-----------------------------
|
||||
|
@@ -27,7 +27,7 @@ Arguments
|
||||
|
||||
``argp``
|
||||
pointer to struct
|
||||
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
|
||||
:c:type:`dvb_diseqc_master_cmd`
|
||||
|
||||
|
||||
Description
|
||||
@@ -35,7 +35,7 @@ Description
|
||||
|
||||
Sends a DiSEqC command to the antenna subsystem.
|
||||
|
||||
.. _dvb-diseqc-master-cmd:
|
||||
.. c:type:: dvb_diseqc_master_cmd
|
||||
|
||||
struct dvb_diseqc_master_cmd
|
||||
============================
|
||||
|
@@ -27,7 +27,7 @@ Arguments
|
||||
|
||||
``argp``
|
||||
pointer to struct struct
|
||||
:ref:`dvb_frontend_info <dvb-frontend-info>`
|
||||
:c:type:`dvb_frontend_info`
|
||||
|
||||
|
||||
Description
|
||||
@@ -40,7 +40,7 @@ takes a pointer to dvb_frontend_info which is filled by the driver.
|
||||
When the driver is not compatible with this specification the ioctl
|
||||
returns an error.
|
||||
|
||||
.. _dvb-frontend-info:
|
||||
.. c:type:: dvb_frontend_info
|
||||
|
||||
struct dvb_frontend_info
|
||||
========================
|
||||
|
@@ -29,7 +29,7 @@ Arguments
|
||||
File descriptor returned by :ref:`open() <frontend_f_open>`.
|
||||
|
||||
``argp``
|
||||
pointer to struct :ref:`dtv_properties <dtv-properties>`
|
||||
pointer to struct :c:type:`dtv_properties`
|
||||
|
||||
|
||||
Description
|
||||
|
@@ -78,7 +78,7 @@ at the above, as they're supported via the new
|
||||
ioctl's, using the :ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>`
|
||||
parameter.
|
||||
|
||||
In the old days, struct :ref:`dvb_frontend_info <dvb-frontend-info>`
|
||||
In the old days, struct :c:type:`dvb_frontend_info`
|
||||
used to contain ``fe_type_t`` field to indicate the delivery systems,
|
||||
filled with either FE_QPSK, FE_QAM, FE_OFDM or FE_ATSC. While this
|
||||
is still filled to keep backward compatibility, the usage of this field
|
||||
@@ -87,7 +87,7 @@ devices support multiple delivery systems. Please use
|
||||
:ref:`DTV_ENUM_DELSYS <DTV-ENUM-DELSYS>` instead.
|
||||
|
||||
On devices that support multiple delivery systems, struct
|
||||
:ref:`dvb_frontend_info <dvb-frontend-info>`::``fe_type_t`` is
|
||||
:c:type:`dvb_frontend_info`::``fe_type_t`` is
|
||||
filled with the currently standard, as selected by the last call to
|
||||
:ref:`FE_SET_PROPERTY <FE_GET_PROPERTY>` using the
|
||||
:ref:`DTV_DELIVERY_SYSTEM <DTV-DELIVERY-SYSTEM>` property.
|
||||
|
@@ -20,7 +20,7 @@ standards, up to 3 groups of statistics can be provided, and
|
||||
plus one metric per each carrier group (called "layer" on ISDB).
|
||||
|
||||
So, in order to be consistent with other delivery systems, the first
|
||||
value at :ref:`dtv_property.stat.dtv_stats <dtv-stats>` array refers
|
||||
value at :c:type:`dtv_property.stat.dtv_stats <dtv_stats>` array refers
|
||||
to the global metric. The other elements of the array represent each
|
||||
layer, starting from layer A(index 1), layer B (index 2) and so on.
|
||||
|
||||
|
@@ -26,7 +26,7 @@ Arguments
|
||||
File descriptor returned by :ref:`open() <frontend_f_open>`.
|
||||
|
||||
``net_if``
|
||||
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
|
||||
pointer to struct :c:type:`dvb_net_if`
|
||||
|
||||
|
||||
Description
|
||||
@@ -38,7 +38,7 @@ ULE) and the interface number for the new interface to be created. When
|
||||
the system call successfully returns, a new virtual network interface is
|
||||
created.
|
||||
|
||||
The struct :ref:`dvb_net_if <dvb-net-if>`::ifnum field will be
|
||||
The struct :c:type:`dvb_net_if`::ifnum field will be
|
||||
filled with the number of the created interface.
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ filled with the number of the created interface.
|
||||
struct dvb_net_if description
|
||||
=============================
|
||||
|
||||
.. _dvb-net-if:
|
||||
.. c:type:: dvb_net_if
|
||||
|
||||
.. flat-table:: struct dvb_net_if
|
||||
:header-rows: 1
|
||||
|
@@ -26,15 +26,15 @@ Arguments
|
||||
File descriptor returned by :ref:`open() <frontend_f_open>`.
|
||||
|
||||
``net_if``
|
||||
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
|
||||
pointer to struct :c:type:`dvb_net_if`
|
||||
|
||||
|
||||
Description
|
||||
===========
|
||||
|
||||
The NET_GET_IF ioctl uses the interface number given by the struct
|
||||
:ref:`dvb_net_if <dvb-net-if>`::ifnum field and fills the content of
|
||||
struct :ref:`dvb_net_if <dvb-net-if>` with the packet ID and
|
||||
:c:type:`dvb_net_if`::ifnum field and fills the content of
|
||||
struct :c:type:`dvb_net_if` with the packet ID and
|
||||
encapsulation type used on such interface. If the interface was not
|
||||
created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
|
||||
the ``errno`` with ``EINVAL`` error code.
|
||||
|
@@ -95,7 +95,7 @@ representing the state of video playback.
|
||||
} video_play_state_t;
|
||||
|
||||
|
||||
.. _video-command:
|
||||
.. c:type:: video_command
|
||||
|
||||
struct video_command
|
||||
====================
|
||||
@@ -146,7 +146,7 @@ video_size_t
|
||||
} video_size_t;
|
||||
|
||||
|
||||
.. _video-event:
|
||||
.. c:type:: video_event
|
||||
|
||||
struct video_event
|
||||
==================
|
||||
@@ -172,7 +172,7 @@ VIDEO_GET_EVENT call.
|
||||
};
|
||||
|
||||
|
||||
.. _video-status:
|
||||
.. c:type:: video_status
|
||||
|
||||
struct video_status
|
||||
===================
|
||||
@@ -203,7 +203,7 @@ case the source video format is not the same as the format of the output
|
||||
device.
|
||||
|
||||
|
||||
.. _video-still-picture:
|
||||
.. c:type:: video_still_picture
|
||||
|
||||
struct video_still_picture
|
||||
==========================
|
||||
@@ -271,7 +271,7 @@ output. The following system types can be set:
|
||||
} video_system_t;
|
||||
|
||||
|
||||
.. _video-highlight:
|
||||
.. c:type:: video_highlight
|
||||
|
||||
struct video_highlight
|
||||
======================
|
||||
@@ -302,7 +302,7 @@ information. The call expects the following format for that information:
|
||||
} video_highlight_t;
|
||||
|
||||
|
||||
.. _video-spu:
|
||||
.. c:type:: video_spu
|
||||
|
||||
struct video_spu
|
||||
================
|
||||
@@ -320,7 +320,7 @@ to the following format:
|
||||
} video_spu_t;
|
||||
|
||||
|
||||
.. _video-spu-palette:
|
||||
.. c:type:: video_spu_palette
|
||||
|
||||
struct video_spu_palette
|
||||
========================
|
||||
@@ -338,7 +338,7 @@ VIDEO_SPU_PALETTE:
|
||||
} video_spu_palette_t;
|
||||
|
||||
|
||||
.. _video-navi-pack:
|
||||
.. c:type:: video_navi_pack
|
||||
|
||||
struct video_navi_pack
|
||||
======================
|
||||
|
Reference in New Issue
Block a user