Clarify doc for SAFE_FREE.
authorMartin Pool <mbp@samba.org>
Thu, 3 Jan 2002 07:49:07 +0000 (07:49 +0000)
committerMartin Pool <mbp@samba.org>
Thu, 3 Jan 2002 07:49:07 +0000 (07:49 +0000)
(This used to be commit 269a7d3c9ba8ca1444653c1aa56b843b8b1df08b)

source3/include/smb_macros.h

index de6f1dc3baf49839108267142862d73c570430cc..2b5be96e7fb2af846cf0901bb573644dff985599 100644 (file)
@@ -1,6 +1,5 @@
 /* 
    Unix SMB/Netbios implementation.
-   Version 1.9.
    SMB parameters and setup
    Copyright (C) Andrew Tridgell 1992-1999
    Copyright (C) John H Terpstra 1996-1999
 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & aSYSTEM) != 0)
 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & aHIDDEN) != 0)
 
-/* free memory if the pointer is valid and zero the pointer */
-
 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
+
+/**
+ * Free memory if the pointer and zero the pointer.
+ *
+ * @note You are explicitly allowed to pass NULL pointers -- they will
+ * always be ignored.
+ **/
 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
 #endif