Document the alignment for refcounted allocations

We use the same definition as malloc().
This commit is contained in:
Emmanuele Bassi 2018-11-27 11:20:05 +00:00
parent f81723e675
commit 76d8fb65b2
2 changed files with 12 additions and 0 deletions

View File

@ -168,6 +168,9 @@
* The data will be freed when its reference count drops to
* zero.
*
* The allocated data is guaranteed to be suitably aligned for any
* built-in type.
*
* Returns: (transfer full) (not nullable): a pointer to the allocated memory
*
* Since: 2.58
@ -192,6 +195,9 @@ g_atomic_rc_box_alloc (gsize block_size)
* The data will be freed when its reference count drops to
* zero.
*
* The allocated data is guaranteed to be suitably aligned for any
* built-in type.
*
* Returns: (transfer full) (not nullable): a pointer to the allocated memory
*
* Since: 2.58

View File

@ -290,6 +290,9 @@ g_rc_box_alloc_full (gsize block_size,
* The data will be freed when its reference count drops to
* zero.
*
* The allocated data is guaranteed to be suitably aligned for any
* built-in type.
*
* Returns: (transfer full) (not nullable): a pointer to the allocated memory
*
* Since: 2.58
@ -314,6 +317,9 @@ g_rc_box_alloc (gsize block_size)
* The data will be freed when its reference count drops to
* zero.
*
* The allocated data is guaranteed to be suitably aligned for any
* built-in type.
*
* Returns: (transfer full) (not nullable): a pointer to the allocated memory
*
* Since: 2.58