[14/16] api: odp_thread.h: updated return descriptions

Message ID 1422528008-29845-15-git-send-email-ola.liljedahl@linaro.org
State New
Headers show

Commit Message

Ola Liljedahl Jan. 29, 2015, 10:40 a.m.
Updated doxygen descriptions, particularly the @return/@retval descriptions.
No change of implementation necessary.

Signed-off-by: Ola Liljedahl <ola.liljedahl@linaro.org>
---
(This document/code contribution attached is provided under the terms of
agreement LES-LTM-21309)

 platform/linux-generic/include/api/odp_thread.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Patch

diff --git a/platform/linux-generic/include/api/odp_thread.h b/platform/linux-generic/include/api/odp_thread.h
index 469d298..d6016cb 100644
--- a/platform/linux-generic/include/api/odp_thread.h
+++ b/platform/linux-generic/include/api/odp_thread.h
@@ -23,9 +23,9 @@  extern "C" {
  */
 
 /**
- * Get thread id
+ * Get thread identifier
  *
- * @return Thread id of the current thread
+ * @return Thread identifier of the current thread
  */
 int odp_thread_id(void);
 
@@ -33,7 +33,7 @@  int odp_thread_id(void);
 /**
  * Get CPU number
  *
- * @return CPU ID where the thread is currently running
+ * @return CPU number where the thread is currently running
  */
 int odp_thread_cpu(void);