lib:util: Cleanup comments in memory.h
authorAndreas Schneider <asn@samba.org>
Mon, 3 Dec 2018 14:35:58 +0000 (15:35 +0100)
committerAndrew Bartlett <abartlet@samba.org>
Thu, 20 Dec 2018 11:16:40 +0000 (12:16 +0100)
Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Stefan Metzmacher <metze@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
lib/util/memory.h

index 099dfbb..0b87a97 100644 (file)
@@ -1,19 +1,19 @@
-/* 
+/*
    Unix SMB/CIFS implementation.
    Samba utility functions
    Copyright (C) Andrew Tridgell 1992-1999
    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2008
-   
+
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
-   
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-   
+
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
@@ -31,8 +31,8 @@
 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
 #endif
 
-/** 
- * Type-safe version of malloc. Allocated one copy of the 
+/**
+ * Type-safe version of malloc. Allocated one copy of the
  * specified data type.
  */
 #define malloc_p(type) (type *)malloc(sizeof(type))
  */
 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count, false)
 
-/** 
+/**
  * Resize an array of elements of one data type. Does type-checking.
  */
 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count, false)
 
-/** 
- * zero a structure 
+/**
+ * Zero a structure.
  */
 #ifndef ZERO_STRUCT
 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
 #endif
 
-/** 
- * zero a structure given a pointer to the structure 
+/**
+ * Zero a structure given a pointer to the structure.
  */
 #ifndef ZERO_STRUCTP
 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
 #endif
 
-/** 
- * zero a structure given a pointer to the structure - no zero check 
+/**
+ * Zero a structure given a pointer to the structure - no zero check.
  */
 #ifndef ZERO_STRUCTPN
 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
 #endif
 
-/* zero an array - note that sizeof(array) must work - ie. it must not be a
-   pointer */
+/**
+ * Zero an array - note that sizeof(array) must work - ie. it must not be a
+ * pointer.
+ */
 #ifndef ZERO_ARRAY
 #define ZERO_ARRAY(x) memset((char *)(x), 0, sizeof(x))
 #endif
 
 /**
- * work out how many elements there are in a static array 
+ * Work out how many elements there are in a static array
  */
 #ifndef ARRAY_SIZE
 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
 #endif
 
-/** 
- * pointer difference macro 
+/**
+ * Pointer difference macro.
  */
 #ifndef PTR_DIFF
 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))