m doc

Signed-off-by: Mattias Andrée <maandree@operamail.com>

2 files changed, 16 insertions, 4 deletions

diff --git a/include/slibc-alloc.h b/include/slibc-alloc.h
index f19982a..3fe31e0 100644
--- a/include/slibc-alloc.h
+++ b/include/slibc-alloc.h
@@ -212,7 +212,7 @@ void* extalloc(void*, size_t, enum extalloc_mode)
  * behaviour and pointer alignment can be tuned.
  * 
  * @param   ptr       The old allocation, see `realloc` for more details.
- * @param   boundary  The alignment.
+ * @param   boundary  The alignment, not checked before necessary.
  * @param   size      The new allocation size, see `realloc` for more details.
  * @param   mode      `REMEMALIGN_CLEAR`, `REMEMALIGN_INIT` or
  *                    `REMEMALIGN_MEMCPY`, or both or neither.
@@ -233,8 +233,12 @@ void* rememalign(void*, size_t, size_t, enum rememalign_mode)
  * - It will never free `ptr`.
  * - The alignment of new pointers can be specified.
  * 
+ * This function cannot be used to force realignment,
+ * the aligment is applied when it is necessary to
+ * create a new allocation.
+ * 
  * @param   ptr       The old allocation, see `realloc` for more details.
- * @param   boundary  The alignment.
+ * @param   boundary  The alignment, not checked before necessary.
  * @param   size      The new allocation size, see `realloc` for more details.
  * @return            The new allocation, see `realloc` for more details.
  * 
diff --git a/src/slibc-alloc.c b/src/slibc-alloc.c
index e6a294b..2ec324a 100644
--- a/src/slibc-alloc.c
+++ b/src/slibc-alloc.c
@@ -262,8 +262,12 @@ void* extalloc(void* ptr, size_t size, enum extalloc_mode mode)
  * This function is similar to `realloc`, however its
  * behaviour and pointer alignment can be tuned.
  * 
+ * This function cannot be used to force realignment,
+ * the aligment is applied when it is necessary to
+ * create a new allocation.
+ * 
  * @param   ptr       The old allocation, see `realloc` for more details.
- * @param   boundary  The alignment.
+ * @param   boundary  The alignment, not checked before necessary.
  * @param   size      The new allocation size, see `realloc` for more details.
  * @param   mode      `REMEMALIGN_CLEAR`, `REMEMALIGN_INIT` or
  *                    `REMEMALIGN_MEMCPY`, or both or neither.
@@ -334,8 +338,12 @@ void* rememalign(void* ptr, size_t boundary, size_t size, enum rememalign_mode m
  * - It will never free `ptr`.
  * - The alignment of new pointers can be specified.
  * 
+ * This function cannot be used to force realignment,
+ * the aligment is applied when it is necessary to
+ * create a new allocation.
+ * 
  * @param   ptr       The old allocation, see `realloc` for more details.
- * @param   boundary  The alignment.
+ * @param   boundary  The alignment, not checked before necessary.
  * @param   size      The new allocation size, see `realloc` for more details.
  * @return            The new allocation, see `realloc` for more details.
  *