redonkable
/
alistair23-linux
1
0
Fork 0
Code Releases Activity

[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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
hifive-unleashed-5.1
Mauro Carvalho Chehab 2016-07-10 07:42:58 -03:00
parent 68cd5e0bed
commit 303393393d
2 changed files with 79 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
Documentation/media/lirc.h.rst.exceptions
View File

@ -1,2 +1,74 @@
# Ignore header name
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

9
Documentation/media/uapi/rc/lirc_ioctl.rst
View File

@ -59,6 +59,7 @@ I/O control requests
corresponding ioctls is undefined.
.. _LIRC_GET_SEND_MODE:
.. _lirc-mode-pulse:
``LIRC_GET_SEND_MODE``
@ -66,6 +67,8 @@ I/O control requests
lircd.
.. _LIRC_GET_REC_MODE:
.. _lirc-mode-mode2:
.. _lirc-mode-lirccode:
``LIRC_GET_REC_MODE``
@ -120,8 +123,8 @@ I/O control requests
cannot be changed.
.. _LIRC_GET_MIN_FILTER_PULSE:
.. _LIRC_GET_MIN_FILTER_PULSE:
.. _LIRC_GET_MAX_FILTER_SPACE:
.. _LIRC_GET_MAX_FILTER_PULSE:
.. _LIRC_GET_MIN_FILTER_SPACE:
.. _LIRC_GET_MAX_FILTER_SPACE:
``LIRC_GET_M{IN,AX}_FILTER_{PULSE,SPACE}``
@ -186,6 +189,7 @@ I/O control requests
.. _LIRC_SET_REC_FILTER_PULSE:
.. _LIRC_SET_REC_FILTER_SPACE:
.. _LIRC_SET_REC_FILTER:
``LIRC_SET_REC_FILTER_{PULSE,SPACE}``
@ -195,6 +199,7 @@ I/O control requests
shall be used instead.
.. _LIRC_SET_MEASURE_CARRIER_MODE:
.. _lirc-mode2-frequency:
``LIRC_SET_MEASURE_CARRIER_MODE``