On 07/10/15 21:03, Bill Fischofer wrote:
Signed-off-by: Bill Fischofer <[email protected]>
---
include/odp/api/queue.h | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h
index 297067d..61e7ace 100644
--- a/include/odp/api/queue.h
+++ b/include/odp/api/queue.h
@@ -258,6 +258,16 @@ odp_schedule_group_t odp_queue_sched_group(odp_queue_t
queue);
uint64_t odp_queue_to_u64(odp_queue_t hdl);
/**
+ * Initialize queue params
+ *
+ * This routine is used to initialize an odp_queue_param_t to its
+ * default values for all fields
+ *
+ * @param param Address of the odp_queue_param_t to be initialized
I have thoughts that we should define the same style for all function
descriptions.
Words likes:
"This routine is used to"
"This routine is intended to be used for"
are useless for function description. And might be omitted to have more
short and exact wording for functions.
Having them in @warning and @note looks like ok.
Maxim.
+ */
+void odp_queue_param_init(odp_queue_param_t *param);
+
+/**
* @}
*/
_______________________________________________
lng-odp mailing list
[email protected]
https://lists.linaro.org/mailman/listinfo/lng-odp
