From 721fb68d6eb6bac539f440fb65596b8d6dd0ccc3 Mon Sep 17 00:00:00 2001 From: Robert Baldyga Date: Wed, 31 Jul 2019 15:48:31 +0200 Subject: [PATCH] Fix ocf_volume_ops documentation Signed-off-by: Robert Baldyga --- inc/ocf_volume.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/inc/ocf_volume.h b/inc/ocf_volume.h index bd7fa3b..3ed36b7 100644 --- a/inc/ocf_volume.h +++ b/inc/ocf_volume.h @@ -89,6 +89,8 @@ struct ocf_volume_ops { * * @param[in] volume Volume * @param[in] volume_params optional volume parameters, opaque to OCF + * + * @return Zero on success, otherwise error code */ int (*open)(ocf_volume_t volume, void *volume_params); @@ -100,16 +102,20 @@ struct ocf_volume_ops { void (*close)(ocf_volume_t volume); /** - * @brief Close volume + * @brief Get maximum io size * * @param[in] volume Volume + * + * @return Maximum io size in bytes */ unsigned int (*get_max_io_size)(ocf_volume_t volume); /** - * @brief Close volume + * @brief Get volume length * * @param[in] volume Volume + * + * @return Volume lenght in bytes */ uint64_t (*get_length)(ocf_volume_t volume); };