[media] libv4l-introdution.rst: fix function definitions

c:type is not the right tag for function definitions.
Replace them by .. c:function::

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-09-08 06:07:47 -03:00
parent 39b6b9005f
commit 9281f251be
1 changed files with 35 additions and 27 deletions

View File

@ -116,45 +116,53 @@ The common file operation methods are provided by libv4l.
Those functions operate just like glibc
open/close/dup/ioctl/read/mmap/munmap:
- :c:type:`int v4l2_open(const char *file, int oflag, ...)` - operates like the
standard :ref:`open() <func-open>` function.
.. c:function:: int v4l2_open(const char *file, int oflag, ...)
- :c:type:`int v4l2_close(int fd)` - operates like the standard
:ref:`close() <func-close>` function.
operates like the standard :ref:`open() <func-open>` function.
- :c:type:`int v4l2_dup(int fd)` - operates like the standard dup() function,
duplicating a file handler.
.. c:function:: int v4l2_close(int fd)
- :c:type:`int v4l2_ioctl (int fd, unsigned long int request, ...)` - operates
like the standard :ref:`ioctl() <func-ioctl>` function.
operates like the standard :ref:`close() <func-close>` function.
- :c:type:`int v4l2_read (int fd, void* buffer, size_t n)` - operates like the
standard :ref:`read() <func-read>` function.
.. c:function:: int v4l2_dup(int fd)
- :c:type:`void v4l2_mmap(void *start, size_t length, int prot, int flags, int
fd, int64_t offset);` - operates like the standard
:ref:`mmap() <func-mmap>` function.
operates like the standard dup() function, duplicating a file handler.
- :c:type:`int v4l2_munmap(void *_start, size_t length);` - operates like the
standard :ref:`munmap() <func-munmap>` function.
.. c:function:: int v4l2_ioctl (int fd, unsigned long int request, ...)
operates like the standard :ref:`ioctl() <func-ioctl>` function.
.. c:function:: int v4l2_read (int fd, void* buffer, size_t n)
operates like the standard :ref:`read() <func-read>` function.
.. c:function:: void v4l2_mmap(void *start, size_t length, int prot, int flags, int fd, int64_t offset);
operates like the standard :ref:`mmap() <func-mmap>` function.
.. c:function:: int v4l2_munmap(void *_start, size_t length);
operates like the standard :ref:`munmap() <func-munmap>` function.
Those functions provide additional control:
- :c:type:`int v4l2_fd_open(int fd, int v4l2_flags)` - opens an already opened
fd for further use through v4l2lib and possibly modify libv4l2's
default behavior through the v4l2_flags argument. Currently,
v4l2_flags can be ``V4L2_DISABLE_CONVERSION``, to disable format
conversion.
.. c:function:: int v4l2_fd_open(int fd, int v4l2_flags)
- :c:type:`int v4l2_set_control(int fd, int cid, int value)` - This function
takes a value of 0 - 65535, and then scales that range to the actual
range of the given v4l control id, and then if the cid exists and is
opens an already opened fd for further use through v4l2lib and possibly
modify libv4l2's default behavior through the v4l2_flags argument.
Currently, v4l2_flags can be ``V4L2_DISABLE_CONVERSION``, to disable
format conversion.
.. c:function:: int v4l2_set_control(int fd, int cid, int value)
This function takes a value of 0 - 65535, and then scales that range to the
actual range of the given v4l control id, and then if the cid exists and is
not locked sets the cid to the scaled value.
- :c:type:`int v4l2_get_control(int fd, int cid)` - This function returns a
value of 0 - 65535, scaled to from the actual range of the given v4l
control id. when the cid does not exist, could not be accessed for
some reason, or some error occurred 0 is returned.
.. c:function:: int v4l2_get_control(int fd, int cid)
This function returns a value of 0 - 65535, scaled to from the actual range
of the given v4l control id. when the cid does not exist, could not be
accessed for some reason, or some error occurred 0 is returned.
v4l1compat.so wrapper library