diff mbox

[07/16] api: odp_init.h: updated return descriptions

Message ID 1422528008-29845-8-git-send-email-ola.liljedahl@linaro.org
State New
Headers show

Commit Message

Ola Liljedahl Jan. 29, 2015, 10:39 a.m. UTC 
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_init.h | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_init.h b/platform/linux-generic/include/api/odp_init.h
index ac856df..c862eae 100644
--- a/platform/linux-generic/include/api/odp_init.h
+++ b/platform/linux-generic/include/api/odp_init.h
@@ -66,8 +66,8 @@  typedef enum odp_log_level {
  * @param[in] level   Log level
  * @param[in] fmt     printf-style message format
  *
- * @return The number of characters logged if succeeded. Otherwise returns
- *         a negative number.
+ * @return The number of characters logged on success
+ * @retval <0 on failure
  */
 int odp_override_log(odp_log_level_e level, const char *fmt, ...);
 
@@ -108,8 +108,8 @@  typedef struct odp_platform_init_t {
  * @param[in] platform_params Those parameters that are passed without
  * interpretation by the ODP API to the implementation.
  *
- * @retval 0 if successful
- * @retval -1 on failure
+ * @retval 0 on success
+ * @retval <0 on failure
  */
 int odp_init_global(odp_init_t *params, odp_platform_init_t *platform_params);
 
@@ -133,8 +133,8 @@  int odp_init_global(odp_init_t *params, odp_platform_init_t *platform_params);
  * @sa odp_init_global()
  * @sa odp_term_local() which must have been called prior to this.
  *
- * @retval 0 if successful
- * @retval -1 on failure
+ * @retval 0 on success
+ * @retval <0 on failure
  */
 int odp_term_global(void);
 
@@ -147,8 +147,8 @@  int odp_term_global(void);
  * @sa odp_term_local()
  * @sa odp_init_global() which must have been called prior to this.
  *
- * @retval 0 if successful
- * @retval -1 on failure
+ * @retval 0 on success
+ * @retval <0 on failure
  */
 int odp_init_local(void);
 
@@ -170,8 +170,8 @@  int odp_init_local(void);
  * @warning The unwinding of HW resources to allow them to be re used without reseting
  * the device is a complex task that the application is expected to coordinate.
  *
- * @retval 1 if successful and more ODP thread exists
- * @retval 0 if successful and it was the last ODP thread
+ * @retval 1 on success and more ODP threads exist
+ * @retval 0 on success and no more ODP threads exist
  * @retval -1 on failure
  */
 int odp_term_local(void);