Fix description of callback return codes

Return codes passed to the callback should not be included as @retval.
Moved to @note section.

Change-Id: Ie14ecc345835bf777a1f1de7844d0fde30cfb3de

diff --git a/lib/ode/luks.h b/lib/ode/luks.h
index 0db6ded..29ae394 100644 (file)
--- a/lib/ode/luks.h
+++ b/lib/ode/luks.h
@@ -78,10 +78,15 @@ typedef void(*ode_luks_event_cb)(ode_luks_operation_e operation,
  * @retval      #ODE_ERROR_NONE Successful
  * @retval      #ODE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval      #ODE_ERROR_CONNECTION_REFUSED Connection to the server failed
- * @retval      #ODE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval      #ODE_ERROR_NO_SUCH_FILE Wrong device
- * @retval      #ODE_ERROR_RESOURCE_BUSY Device is busy
- * @retval      #ODE_ERROR_UNKNOWN Unknown error
+ *
+ * @note        The following return codes can be passed to the callback
+ *              function as a result of this function call:
+ *              #ODE_ERROR_NONE Successful
+ *              #ODE_ERROR_INVALID_PARAMETER Invalid parameter
+ *              #ODE_ERROR_OUT_OF_MEMORY Out of memory
+ *              #ODE_ERROR_NO_SUCH_FILE Wrong device
+ *              #ODE_ERROR_RESOURCE_BUSY Device is busy
+ *              #ODE_ERROR_UNKNOWN Unknown error
  *
  * @pre         The @a device must be present and neither mapped nor mounted.
  *
@@ -114,11 +119,16 @@ ODE_API int ode_luks_format(const char* device, const char* password);
  * @retval      #ODE_ERROR_NONE Successful
  * @retval      #ODE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval      #ODE_ERROR_CONNECTION_REFUSED Connection to the server failed
- * @retval      #ODE_ERROR_KEY_REJECTED Wrong password
- * @retval      #ODE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval      #ODE_ERROR_NO_SUCH_FILE Wrong device or mapping
- * @retval      #ODE_ERROR_RESOURCE_BUSY Device is busy
- * @retval      #ODE_ERROR_UNKNOWN Unknown error
+ *
+ * @note        The following return codes can be passed to the callback
+ *              function as a result of this function call:
+ *              #ODE_ERROR_NONE Successful
+ *              #ODE_ERROR_INVALID_PARAMETER Invalid parameter
+ *              #ODE_ERROR_KEY_REJECTED Wrong password
+ *              #ODE_ERROR_OUT_OF_MEMORY Out of memory
+ *              #ODE_ERROR_NO_SUCH_FILE Wrong device or mapping
+ *              #ODE_ERROR_RESOURCE_BUSY Device is busy
+ *              #ODE_ERROR_UNKNOWN Unknown error
  *
  * @pre         The @a device must be a LUKS device formatted with
  *              ode_luks_format(). The mapping must not exist.
@@ -152,10 +162,15 @@ ODE_API int ode_luks_open(const char* device,
  * @retval      #ODE_ERROR_NONE Successful
  * @retval      #ODE_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval      #ODE_ERROR_CONNECTION_REFUSED Connection to the server failed
- * @retval      #ODE_ERROR_OUT_OF_MEMORY Out of memory
- * @retval      #ODE_ERROR_NO_SUCH_FILE Wrong mapping
- * @retval      #ODE_ERROR_RESOURCE_BUSY Device is busy
- * @retval      #ODE_ERROR_UNKNOWN Unknown error
+ *
+ * @note        The following return codes can be passed to the callback
+ *              function as a result of this function call:
+ *              #ODE_ERROR_NONE Successful
+ *              #ODE_ERROR_INVALID_PARAMETER Invalid parameter
+ *              #ODE_ERROR_OUT_OF_MEMORY Out of memory
+ *              #ODE_ERROR_NO_SUCH_FILE Wrong mapping
+ *              #ODE_ERROR_RESOURCE_BUSY Device is busy
+ *              #ODE_ERROR_UNKNOWN Unknown error
  *
  * @pre         The mapping must be created by a call to ode_luks_open().
  *              The mapping must not be mounted.