Clean-up: Remove java-doc style function header from session.h
authorJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 7 Aug 2015 19:10:18 +0000 (15:10 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 7 Aug 2015 19:11:58 +0000 (15:11 -0400)
While we should move to a consistent API documentation style,
this function's documentation is inconsistent with the rest
of the public LTTng API.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
include/lttng/session.h

index 302f0fc026fc112a1e7d2effd635ed04a4db7da3..e0594d2e82e452bf072d90899b945b2afc31be3c 100644 (file)
@@ -139,10 +139,10 @@ extern int lttng_untrack_pid(struct lttng_handle *handle, int pid);
 /*
  * List PIDs in the tracker.
  *
- * @enabled is set to whether the PID tracker is enabled.
- * @pids is set to an allocated array of PIDs currently tracked. On
- * success, @pids must be freed by the caller.
- * @nr_pids is set to the number of entries contained by the @pids array.
+ * enabled is set to whether the PID tracker is enabled.
+ * pids is set to an allocated array of PIDs currently tracked. On
+ * success, pids must be freed by the caller.
+ * nr_pids is set to the number of entries contained by the pids array.
  *
  * Returns 0 on success, else a negative LTTng error code.
  */
This page took 0.050886 seconds and 4 git commands to generate.