Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / intern / memory_utils.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file \ingroup bli
18  *  \brief Generic memory manipulation API.
19  *
20  * This is to extend on existing functions
21  * such as ``memcpy`` & ``memcmp``.
22  */
23 #include <string.h>
24
25 #include "BLI_sys_types.h"
26 #include "BLI_utildefines.h"
27
28 #include "BLI_memory_utils.h"
29
30 #include "BLI_strict_flags.h"
31
32 /**
33  * Check if memory is zero'd, as with memset(s, 0, nbytes)
34  */
35 bool BLI_memory_is_zero(const void *s, const size_t nbytes)
36 {
37         const char *s_byte = s;
38         const char *s_end = (const char *)s + nbytes;
39
40         while ((s_byte != s_end) && (*s_byte == 0)) {
41                 s_byte++;
42         }
43
44         return (s_byte == s_end);
45 }