From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Wed, 18 Nov 2020 16:55:24 +0000 (-0500)
Subject: Docs: payload/buffer view: validate is missing an argument description
X-Git-Tag: v2.13.0-rc1~422
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=b2530e4d8651a3e48e86a90765af290e2b53969d;p=lttng-tools.git

Docs: payload/buffer view: validate is missing an argument description

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I3d575dcda6c3e6820e911ab3c4e28b18d29f045c
---

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);