aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsantosh shukla <santosh.shukla@linaro.org>2013-12-26 20:38:27 +0530
committerMaxim Uvarov <maxim.uvarov@linaro.org>2013-12-30 13:01:00 +0400
commit13c71f3c081d37b9afbb1c0601872650dde7966a (patch)
tree0a115bb55c76e266c6ef1fb3363b4c38d980d71f
parent745022f2e6ba783575bbfca6cff0bc71a17802e3 (diff)
few doc warning build fixesodp-0.1
Signed-off-by: santosh shukla <santosh.shukla@linaro.org>
-rw-r--r--include/odp_atomic.h3
-rw-r--r--include/odp_coremask.h3
-rw-r--r--include/odp_packet_io.h4
-rw-r--r--include/odp_thread.h2
4 files changed, 9 insertions, 3 deletions
diff --git a/include/odp_atomic.h b/include/odp_atomic.h
index 93d323910..cb6ff2d7f 100644
--- a/include/odp_atomic.h
+++ b/include/odp_atomic.h
@@ -58,6 +58,7 @@ static inline void odp_atomic_init_int(odp_atomic_int_t *ptr)
*
* @param ptr An atomic variable
*
+ * @return atomic integer value
*/
static inline int odp_atomic_load_int(odp_atomic_int_t *ptr)
{
@@ -140,6 +141,7 @@ static inline void odp_atomic_init_u32(odp_atomic_u32_t *ptr)
*
* @param ptr An atomic variable
*
+ * @return atomic uint32 value
*/
static inline uint32_t odp_atomic_load_u32(odp_atomic_u32_t *ptr)
{
@@ -225,6 +227,7 @@ static inline void odp_atomic_init_u64(odp_atomic_u64_t *ptr)
*
* @param ptr An atomic variable
*
+ * @return atomic uint64 value
*/
static inline uint64_t odp_atomic_load_u64(odp_atomic_u64_t *ptr)
{
diff --git a/include/odp_coremask.h b/include/odp_coremask.h
index 54e6f9f92..3f537e11a 100644
--- a/include/odp_coremask.h
+++ b/include/odp_coremask.h
@@ -109,13 +109,14 @@ void odp_coremask_clr(int core, odp_coremask_t *mask);
* Test if core is a member of mask
* @param core Core number
* @param mask Core mask to check if core num set or not
- * return non-zero if set otherwise 0
+ * @return non-zero if set otherwise 0
*/
int odp_coremask_isset(int core, odp_coremask_t *mask);
/**
* Count number of cores in mask
* @param mask Core mask
+ * @return coremask count
*/
int odp_coremask_count(odp_coremask_t *mask);
diff --git a/include/odp_packet_io.h b/include/odp_packet_io.h
index 978089b2a..3572d9202 100644
--- a/include/odp_packet_io.h
+++ b/include/odp_packet_io.h
@@ -71,7 +71,9 @@ int odp_pktio_send(odp_pktio_t id, odp_packet_t pkt_table[], unsigned len);
/**
* Set the default input queue to be associated with a pktio handle
*
- * @param
+ * @param id ODP packet IO handle
+ * @param queue default input queue set
+ * @return 0 on success or -1 on error
*/
int odp_pktio_inq_setdef(odp_pktio_t id, odp_queue_t queue);
diff --git a/include/odp_thread.h b/include/odp_thread.h
index b92825dd6..31057f7b2 100644
--- a/include/odp_thread.h
+++ b/include/odp_thread.h
@@ -27,7 +27,7 @@ extern "C" {
/**
* Create thread id
*
- * @param core dedicated for the thread
+ * @param core Core dedicated for the thread
* @return New thread id
*/
int odp_thread_create(int core);