summaryrefslogtreecommitdiffstats
path: root/src/kiro-trb.h
diff options
context:
space:
mode:
authorTimo Dritschler <timo.dritschler@kit.edu>2015-02-06 20:23:43 +0100
committerTimo Dritschler <timo.dritschler@kit.edu>2015-03-09 17:05:14 +0100
commitf16d62f41eac5c715eba309d79d23f3e0273cdfb (patch)
tree3d8656f663d4d072048add7a07f116fb91798146 /src/kiro-trb.h
parent74bb04dedeb66ca1175360cb77d0596b3e3630b5 (diff)
downloadkiro-f16d62f41eac5c715eba309d79d23f3e0273cdfb.tar.gz
kiro-f16d62f41eac5c715eba309d79d23f3e0273cdfb.tar.bz2
kiro-f16d62f41eac5c715eba309d79d23f3e0273cdfb.tar.xz
kiro-f16d62f41eac5c715eba309d79d23f3e0273cdfb.zip
Added new "Kiro Sync Buffer" (KiroSb) class.
Added first prototype implementation of KiroSb Fixed some typos
Diffstat (limited to 'src/kiro-trb.h')
-rw-r--r--src/kiro-trb.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/kiro-trb.h b/src/kiro-trb.h
index 6620191..bec8626 100644
--- a/src/kiro-trb.h
+++ b/src/kiro-trb.h
@@ -286,6 +286,8 @@ int kiro_trb_is_setup (KiroTrb *trb);
* @trb: #KiroTrb to perform the operation on
* @element_size: Individual size of the elements to store in bytes
* @element_count: Maximum number of elements to be stored
+ * Returns:
+ * integer: < 0 for error, >= 0 for success
* Description:
* (Re)Allocates internal memory for the given ammount of elements
* at the given individual size
@@ -310,7 +312,7 @@ int kiro_trb_reshape (KiroTrb *trb, uint64_t element_size, uint64_t element_coun
* tries to copy that memory into its own.
* Notes:
* The given memory is treated as a correct KIRO TRB memory block,
- * including a consistend memory header. That header is read and
+ * including a consistent memory header. That header is read and
* then cloned into the internal memory according to the headers
* information.
* If the given memory is not a consistent KIRO TRB memory block,
@@ -373,13 +375,14 @@ void kiro_trb_refresh (KiroTrb *trb);
* takes ownership over the memory.
* Notes:
* The given memory is treated as a correct KIRO TRB memory block,
- * including a consistend memory header. That header is read and
+ * including a consistent memory header. That header is read and
* the TRB sets up all internal structures in accordance to that
* header.
* If the given memory is not a consistent KIRO TRB memory block,
* the behavior of this function is undefined.
* The TRB takes full ownership of the given memory and may free
* it at will.
+ * Any previously owned memory is freed.
* See also:
* kiro_trb_clone, kiro_trb_reshape
*/