From 0c2ac5119b3015e223357d168b00515a822728cc Mon Sep 17 00:00:00 2001 From: Petri Savolainen Date: Tue, 16 Apr 2019 15:40:52 +0300 Subject: api: queue: context default value NULL Highlight that queue context default value is NULL. This was defined already in odp_queue_param_t specification. Signed-off-by: Petri Savolainen Reviewed-by: Matias Elo --- include/odp/api/spec/queue.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'include') 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); -- cgit v1.2.3