doc-rst: FE_READ_SNR: improve man-like format

Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c:function::

While here, use the same way we document man-like pages,
at the V4L side of the book and add escapes to asterisks.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-04 12:28:52 -03:00
parent 9de499fe09
commit 6fcf645ec9

View file

@ -6,18 +6,20 @@
FE_READ_SNR
***********
DESCRIPTION
Description
-----------
This ioctl call returns the signal-to-noise ratio for the signal
currently received by the front-end. For this command, read-only access
to the device is sufficient.
SYNOPSIS
Synopsis
--------
int ioctl(int fd, int request = :ref:`FE_READ_SNR`,
uint16_t *snr);
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
PARAMETERS
Arguments
----------
@ -40,12 +42,13 @@ PARAMETERS
- .. row 3
- uint16_t *snr
- uint16_t \*snr
- The signal-to-noise ratio is stored into *snr.
- The signal-to-noise ratio is stored into \*snr.
RETURN VALUE
Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the