[PATCH 07/17] kernel-shark-qt: Fix the documentation of libkshark-model

From: Yordan Karadzhov <ykaradzhov@vmware.com>
To: "rostedt@goodmis.org" <rostedt@goodmis.org>
Cc: "linux-trace-devel@vger.kernel.org" <linux-trace-devel@vger.kernel.org>
Subject: [PATCH 07/17] kernel-shark-qt: Fix the documentation of libkshark-model
Date: Wed, 28 Nov 2018 15:16:15 +0000	[thread overview]
Message-ID: <20181128151530.21965-8-ykaradzhov@vmware.com> (raw)
In-Reply-To: <20181128151530.21965-1-ykaradzhov@vmware.com>

This patch fixes a simple copy/paste mistake in the Doxygen
documentation of the ksmodel_get_cpu_xxx() functions.

Signed-off-by: Yordan Karadzhov <ykaradzhov@vmware.com>
---
 kernel-shark-qt/src/libkshark-model.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/kernel-shark-qt/src/libkshark-model.c b/kernel-shark-qt/src/libkshark-model.c
index 461f88e..76e2940 100644
--- a/kernel-shark-qt/src/libkshark-model.c
+++ b/kernel-shark-qt/src/libkshark-model.c
@@ -1070,7 +1070,7 @@ static int ksmodel_get_entry_cpu(const struct kshark_entry *entry)
  * @param index: Optional output location for the index of the requested
  *		 entry inside the array.
  *
- * @returns Process Id of the task if an entry has been found. Else a negative
+ * @returns The CPU Id of the task if an entry has been found. Else a negative
  *	    Identifier (KS_EMPTY_BIN or KS_FILTERED_BIN).
  */
 int ksmodel_get_cpu_front(struct kshark_trace_histo *histo,
@@ -1103,7 +1103,7 @@ int ksmodel_get_cpu_front(struct kshark_trace_histo *histo,
  * @param index: Optional output location for the index of the requested
  *		 entry inside the array.
  *
- * @returns Process Id of the task if an entry has been found. Else a negative
+ * @returns The CPU Id of the task if an entry has been found. Else a negative
  *	    Identifier (KS_EMPTY_BIN or KS_FILTERED_BIN).
  */
 int ksmodel_get_cpu_back(struct kshark_trace_histo *histo,
-- 
2.17.1
