mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2024-12-29 11:06:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

aux/util: Improve docs for calloc wrappers

Browse source
This commit is contained in:
Ryan Pavlik 2019-06-18 14:09:16 -05:00
parent edfa0323a3
commit 901254b9ac
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/xrt/auxiliary/util/u_misc.h
View file

@ -9,7 +9,7 @@
#pragma once
#include <stdlib.h>
#include <stdlib.h> // for calloc
#include <string.h> // for memset
#ifdef __cplusplus
@ -21,6 +21,9 @@ extern "C" {
* Allocate and zero the give size and casts the memory into a pointer of the
* given type.
*
* Use instead of a bare calloc, but only when U_TYPED_CALLOC and
* U_TYPED_ARRAY_CALLOC do not meet your needs.
*
* @ingroup aux_util
*/
#define U_CALLOC_WITH_CAST(TYPE, SIZE) ((TYPE *)calloc(1, SIZE))
@ -29,6 +32,8 @@ extern "C" {
* Allocate and zero the space required for some type, and cast the return type
* appropriately.
*
* Use instead of a bare calloc when allocating a single structure.
*
* @ingroup aux_util
*/
#define U_TYPED_CALLOC(TYPE) ((TYPE *)calloc(1, sizeof(TYPE)))
@ -37,6 +42,9 @@ extern "C" {
* Allocate and zero the space required for some type, and cast the return type
* appropriately.
*
* Use instead of a bare calloc when allocating an array of a type.
* This includes allocating C strings: pass char as the type.
*
* @ingroup aux_util
*/
#define U_TYPED_ARRAY_CALLOC(TYPE, COUNT) \
@ -45,7 +53,7 @@ extern "C" {
/*!
* Zeroes the correct amount of memory based on the type pointed-to by the
* argument.
*
*
* Use instead of memset(..., 0, ...) on a structure or pointer to structure.
*
* @ingroup aux_util
@ -55,7 +63,7 @@ extern "C" {
/*!
* Zeroes the correct amount of memory based on the type and size of the static
* array named in the argument.
*
*
* Use instead of memset(..., 0, ...) on an array.
*
* @ingroup aux_util