From b2530e4d8651a3e48e86a90765af290e2b53969d Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Wed, 18 Nov 2020 11:55:24 -0500 Subject: [PATCH] Docs: payload/buffer view: validate is missing an argument description MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau Change-Id: I3d575dcda6c3e6820e911ab3c4e28b18d29f045c --- src/common/buffer-view.h | 2 ++ src/common/payload-view.h | 2 ++ 2 files changed, 4 insertions(+) diff --git a/src/common/buffer-view.h b/src/common/buffer-view.h index 88fd42dd4..47f09b430 100644 --- a/src/common/buffer-view.h +++ b/src/common/buffer-view.h @@ -41,6 +41,8 @@ struct lttng_buffer_view lttng_buffer_view_init( * After calling the buffer view creation functions, callers should verify * if the resquested length (if any is explicitly provided) could be mapped * to a new view. + * + * @view Buffer view to validate */ LTTNG_HIDDEN bool lttng_buffer_view_is_valid(const struct lttng_buffer_view *view); diff --git a/src/common/payload-view.h b/src/common/payload-view.h index 9aa15f456..7fe5e7d29 100644 --- a/src/common/payload-view.h +++ b/src/common/payload-view.h @@ -59,6 +59,8 @@ struct lttng_payload_view { * After calling the payload view creation functions, callers should verify * if the resquested length (if any is explicitly provided) could be mapped * to a new view. + * + * @view Payload to validate */ LTTNG_HIDDEN bool lttng_payload_view_is_valid(const struct lttng_payload_view *view); -- 2.34.1