Commit 30339339 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

[media] doc-rst: do cross-references between header and the doc

Now that the LIRC header was added, we can cross-reference it
and identify the documentation gaps.

There are lots of stuff missing there, but at least now we
can avoid the gap to increase.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 68cd5e0b
# Ignore header name # Ignore header name
ignore define _LINUX_LIRC_H ignore define _LINUX_LIRC_H
# Ignore helper macros
ignore define lirc_t
ignore define LIRC_SPACE
ignore define LIRC_PULSE
ignore define LIRC_FREQUENCY
ignore define LIRC_TIMEOUT
ignore define LIRC_VALUE
ignore define LIRC_MODE2
ignore define LIRC_IS_SPACE
ignore define LIRC_IS_PULSE
ignore define LIRC_IS_FREQUENCY
ignore define LIRC_IS_TIMEOUT
ignore define LIRC_MODE2SEND
ignore define LIRC_SEND2MODE
ignore define LIRC_MODE2REC
ignore define LIRC_REC2MODE
ignore define LIRC_CAN_SEND
ignore define LIRC_CAN_REC
# Undocumented macros
ignore define PULSE_BIT
ignore define PULSE_MASK
ignore define LIRC_MODE2_SPACE
ignore define LIRC_MODE2_PULSE
ignore define LIRC_MODE2_TIMEOUT
ignore define LIRC_VALUE_MASK
ignore define LIRC_MODE2_MASK
ignore define LIRC_MODE_RAW
ignore define LIRC_CAN_SEND_RAW
ignore define LIRC_CAN_SEND_PULSE
ignore define LIRC_CAN_SEND_MODE2
ignore define LIRC_CAN_SEND_LIRCCODE
ignore define LIRC_CAN_SEND_MASK
ignore define LIRC_CAN_SET_SEND_CARRIER
ignore define LIRC_CAN_SET_SEND_DUTY_CYCLE
ignore define LIRC_CAN_SET_TRANSMITTER_MASK
ignore define LIRC_CAN_REC_RAW
ignore define LIRC_CAN_REC_PULSE
ignore define LIRC_CAN_REC_MODE2
ignore define LIRC_CAN_REC_LIRCCODE
ignore define LIRC_CAN_REC_MASK
ignore define LIRC_CAN_SET_REC_CARRIER
ignore define LIRC_CAN_SET_REC_DUTY_CYCLE
ignore define LIRC_CAN_SET_REC_DUTY_CYCLE_RANGE
ignore define LIRC_CAN_SET_REC_CARRIER_RANGE
ignore define LIRC_CAN_GET_REC_RESOLUTION
ignore define LIRC_CAN_SET_REC_TIMEOUT
ignore define LIRC_CAN_SET_REC_FILTER
ignore define LIRC_CAN_MEASURE_CARRIER
ignore define LIRC_CAN_USE_WIDEBAND_RECEIVER
ignore define LIRC_CAN_SEND(x)
ignore define LIRC_CAN_REC(x)
ignore define LIRC_CAN_NOTIFY_DECODE
...@@ -59,6 +59,7 @@ I/O control requests ...@@ -59,6 +59,7 @@ I/O control requests
corresponding ioctls is undefined. corresponding ioctls is undefined.
.. _LIRC_GET_SEND_MODE: .. _LIRC_GET_SEND_MODE:
.. _lirc-mode-pulse:
``LIRC_GET_SEND_MODE`` ``LIRC_GET_SEND_MODE``
...@@ -66,6 +67,8 @@ I/O control requests ...@@ -66,6 +67,8 @@ I/O control requests
lircd. lircd.
.. _LIRC_GET_REC_MODE: .. _LIRC_GET_REC_MODE:
.. _lirc-mode-mode2:
.. _lirc-mode-lirccode:
``LIRC_GET_REC_MODE`` ``LIRC_GET_REC_MODE``
...@@ -120,8 +123,8 @@ I/O control requests ...@@ -120,8 +123,8 @@ I/O control requests
cannot be changed. cannot be changed.
.. _LIRC_GET_MIN_FILTER_PULSE: .. _LIRC_GET_MIN_FILTER_PULSE:
.. _LIRC_GET_MIN_FILTER_PULSE: .. _LIRC_GET_MAX_FILTER_PULSE:
.. _LIRC_GET_MAX_FILTER_SPACE: .. _LIRC_GET_MIN_FILTER_SPACE:
.. _LIRC_GET_MAX_FILTER_SPACE: .. _LIRC_GET_MAX_FILTER_SPACE:
``LIRC_GET_M{IN,AX}_FILTER_{PULSE,SPACE}`` ``LIRC_GET_M{IN,AX}_FILTER_{PULSE,SPACE}``
...@@ -186,6 +189,7 @@ I/O control requests ...@@ -186,6 +189,7 @@ I/O control requests
.. _LIRC_SET_REC_FILTER_PULSE: .. _LIRC_SET_REC_FILTER_PULSE:
.. _LIRC_SET_REC_FILTER_SPACE: .. _LIRC_SET_REC_FILTER_SPACE:
.. _LIRC_SET_REC_FILTER:
``LIRC_SET_REC_FILTER_{PULSE,SPACE}`` ``LIRC_SET_REC_FILTER_{PULSE,SPACE}``
...@@ -195,6 +199,7 @@ I/O control requests ...@@ -195,6 +199,7 @@ I/O control requests
shall be used instead. shall be used instead.
.. _LIRC_SET_MEASURE_CARRIER_MODE: .. _LIRC_SET_MEASURE_CARRIER_MODE:
.. _lirc-mode2-frequency:
``LIRC_SET_MEASURE_CARRIER_MODE`` ``LIRC_SET_MEASURE_CARRIER_MODE``
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment