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 88fd42dd43c39a384e1ccfa05ac34a0a338da00f..47f09b430c5be1c3b538c86d5eae20b1546a217d 100644 (file)
--- 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.
  * 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);
  */
 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 9aa15f45620e0b42a8d5525d9f48ff86de6462cc..7fe5e7d29fe2500105dfbe22e7baf5d68ea234b0 100644 (file)
--- 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.
  * 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);
  */
 LTTNG_HIDDEN
 bool lttng_payload_view_is_valid(const struct lttng_payload_view *view);