Currently, there's no way to document #define foo <value>
with kernel-doc. So, convert it to an enum, and document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
---
include/media/v4l2-ioctl.h | 33 +++++++++++++++++++--------------
1 file changed, 19 insertions(+), 14 deletions(-)
diff --git a/include/media/v4l2-ioctl.h b/include/media/v4l2-ioctl.h
index bd5312118013..136e2cffcf9e 100644
--- a/include/media/v4l2-ioctl.h
+++ b/include/media/v4l2-ioctl.h
@@ -588,20 +588,25 @@ struct v4l2_ioctl_ops {
};
-/* v4l debugging and diagnostics */
-
-/* Device debug flags to be used with the video device debug attribute */
-
-/* Just log the ioctl name + error code */
-#define V4L2_DEV_DEBUG_IOCTL 0x01
-/* Log the ioctl name arguments + error code */
-#define V4L2_DEV_DEBUG_IOCTL_ARG 0x02
-/* Log the file operations open, release, mmap and get_unmapped_area */
-#define V4L2_DEV_DEBUG_FOP 0x04
-/* Log the read and write file operations and the VIDIOC_(D)QBUF ioctls */
-#define V4L2_DEV_DEBUG_STREAMING 0x08
-/* Log poll() */
-#define V4L2_DEV_DEBUG_POLL 0x10
+/**
+ * enum v4l2_debug_flags - Device debug flags to be used with the video
+ * device debug attribute
+ *
+ * @V4L2_DEV_DEBUG_IOCTL: Just log the ioctl name + error code.
+ * @V4L2_DEV_DEBUG_IOCTL_ARG: Log the ioctl name arguments + error code.
+ * @V4L2_DEV_DEBUG_FOP: Log the file operations and open, release,
+ * mmap and get_unmapped_area syscalls.
+ * @V4L2_DEV_DEBUG_STREAMING: Log the read and write syscalls and
+ * :c:ref:`VIDIOC_[Q|DQ]BUFF <VIDIOC_QBUF>` ioctls.
+ * @V4L2_DEV_DEBUG_POLL: Log poll syscalls.
+ */
+enum v4l2_debug_flags {
+ V4L2_DEV_DEBUG_IOCTL = 0x01,
+ V4L2_DEV_DEBUG_IOCTL_ARG = 0x02,
+ V4L2_DEV_DEBUG_FOP = 0x04,
+ V4L2_DEV_DEBUG_STREAMING = 0x08,
+ V4L2_DEV_DEBUG_POLL = 0x10,
+};
/* Video standard functions */
--
2.13.5
