Commit d090484c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: FE_GET_FRONTEND: 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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 9e1f61c0

Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst

+10 −8
Original line number Diff line number Diff line
@@ -6,18 +6,19 @@ 
FE_GET_FRONTEND

***************



DESCRIPTION

Description

-----------



This ioctl call queries the currently effective frontend parameters. For

this command, read-only access to the device is sufficient.



SYNOPSIS

Synopsis

--------



int ioctl(int fd, int request =

:ref:`FE_GET_FRONTEND`, struct

dvb_frontend_parameters *p);

.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)



PARAMETERS

Arguments

----------
@@ -41,12 +42,13 @@ PARAMETERS 


    -  .. row 3



       -  struct dvb_frontend_parameters *p

       -  struct dvb_frontend_parameters \*p



       -  Points to parameters for tuning operation.





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