summaryrefslogtreecommitdiff
path: root/src/erasurecode.c
diff options
context:
space:
mode:
authorTushar Gohad <tushar.gohad@intel.com>2016-03-05 12:40:58 -0700
committerTushar Gohad <tushar.gohad@intel.com>2016-03-05 12:46:14 -0700
commit888c276000b0dcf7aac94d92256a0ae52a1294cc (patch)
tree06edb3ce184be69621a82c8de091405120ee1c7f /src/erasurecode.c
parent96790608c62d927512d2b60e97e19bbb2b860b9f (diff)
downloadliberasurecode-doxygen_fixes.tar.gz
Doxygen related fixesdoxygen_fixes
Diffstat (limited to 'src/erasurecode.c')
-rw-r--r--src/erasurecode.c14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/erasurecode.c b/src/erasurecode.c
index 13e5f02..0d04f62 100644
--- a/src/erasurecode.c
+++ b/src/erasurecode.c
@@ -231,7 +231,7 @@ liberasurecode_exit(void) {
*
* @param id - one of the supported backends as
* defined by ec_backend_id_t
- * @param ec_args - arguments to the EC backend
+ * @param args - arguments to the EC backend
* arguments common to all backends
* k - number of data fragments
* m - number of parity fragments
@@ -298,7 +298,7 @@ int liberasurecode_instance_create(const ec_backend_id_t id,
/**
* Close a liberasurecode instance
*
- * @param liberasurecode descriptor to close
+ * @param desc - liberasurecode descriptor to close
*/
int liberasurecode_instance_destroy(int desc)
{
@@ -506,7 +506,7 @@ int liberasurecode_decode_cleanup(int desc, char *data)
*
* @param desc - liberasurecode descriptor/handle
* from liberasurecode_instance_create()
- * @param fragments - erasure encoded fragments (> = k)
+ * @param available_fragments - erasure encoded fragments (> = k)
* @param num_fragments - number of fragments being passed in
* @param fragment_len - length of each fragment (assume they are the same)
* @param force_metadata_checks - force fragment metadata checks (default: 0)
@@ -907,12 +907,12 @@ out:
* Return a list of lists with valid rebuild indexes given
* a list of missing indexes.
*
- * @desc: liberasurecode instance descriptor (obtained with
+ * @param desc - liberasurecode instance descriptor (obtained with
* liberasurecode_instance_create)
- * @fragments_to_reconstruct list of indexes to reconstruct
- * @fragments_to_exclude list of indexes to exclude from
+ * @param fragments_to_reconstruct - list of indexes to reconstruct
+ * @param fragments_to_exclude - list of indexes to exclude from
reconstruction equation
- * @fragments_needed list of fragments needed to reconstruct
+ * @param fragments_needed - list of fragments needed to reconstruct
fragments in fragments_to_reconstruct
*
* @return a list of lists (bitmaps) of indexes to rebuild data