[12/16] api: odp_schedule.h: updated return descriptions

Message ID 1422528008-29845-13-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_schedule.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Patch

diff --git a/platform/linux-generic/include/api/odp_schedule.h b/platform/linux-generic/include/api/odp_schedule.h
index 688a6db..edf26a2 100644
--- a/platform/linux-generic/include/api/odp_schedule.h
+++ b/platform/linux-generic/include/api/odp_schedule.h
@@ -59,7 +59,8 @@  uint64_t odp_schedule_wait_time(uint64_t ns);
  *                Use odp_schedule_wait_time() to convert time to other wait
  *                values.
  *
- * @return Next highest priority event, or ODP_EVENT_INVALID
+ * @return Next highest priority event
+ * @retval ODP_EVENT_INVALID on timeout and no events available
  */
 odp_event_t odp_schedule(odp_queue_t *from, uint64_t wait);