aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--include/odp/api/spec/queue.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h
index 605831c50..f40eb7afa 100644
--- a/include/odp/api/spec/queue.h
+++ b/include/odp/api/spec/queue.h
@@ -116,10 +116,16 @@ int odp_queue_context_set(odp_queue_t queue, void *context, uint32_t len);
/**
* Get queue context
*
+ * Returns previously stored queue context pointer. The context pointer may
+ * be set with odp_queue_context_set() or during queue creation
+ * (see odp_queue_param_t). The pointer value is set to NULL by default.
+ *
* @param queue Queue handle
*
* @return pointer to the queue context
* @retval NULL on failure
+ *
+ * @see odp_queue_context_set(), odp_queue_create()
*/
void *odp_queue_context(odp_queue_t queue);