header comment cleanup, explain whats the difference between confusingly named drarno...
authorCampbell Barton <ideasman42@gmail.com>
Sat, 14 Jul 2012 15:29:45 +0000 (15:29 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Sat, 14 Jul 2012 15:29:45 +0000 (15:29 +0000)
intern/guardedalloc/MEM_guardedalloc.h
intern/guardedalloc/intern/mallocn.c
source/blender/blenlib/BLI_mempool.h
source/blender/editors/space_node/drawnode.c
source/blender/editors/space_node/node_draw.c

index dfb3fe6947453b0ecbfe71e2593ab3e7936d9139..65ce7baba1e4c7545876b651f4924f8ea2ca8e32 100644 (file)
  *
  * The Original Code is: all of this file.
  *
- * Contributor(s): none yet.
+ * Contributor(s): Brecht Van Lommel
+ *                 Campbell Barton
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file MEM_guardedalloc.h
- *  \ingroup MEM
+/**
+ * \file MEM_guardedalloc.h
+ * \ingroup MEM
+ *
+ * \author Copyright (C) 2001 NaN Technologies B.V.
+ * \brief Read \ref MEMPage
  *
- *  \author Copyright (C) 2001 NaN Technologies B.V.
- *  \brief Read \ref MEMPage
- */
-
-/** 
  * \page MEMPage Guarded memory(de)allocation
  *
  * \section aboutmem c-style guarded memory allocation
@@ -118,8 +118,9 @@ extern "C" {
        __attribute__((alloc_size(1)))
 #endif
        ;
-       
-       /** Allocate a block of memory of size len, with tag name str. The
+
+       /**
+        * Allocate a block of memory of size len, with tag name str. The
         * name must be a static, because only a pointer to it is stored !
         * */
        void *MEM_mallocN(size_t len, const char *str)
@@ -129,8 +130,9 @@ extern "C" {
        __attribute__((alloc_size(1)))
 #endif
        ;
-       
-       /** Same as callocN, clears memory and uses mmap (disk cached) if supported.
+
+       /**
+        * Same as callocN, clears memory and uses mmap (disk cached) if supported.
         * Can be free'd with MEM_freeN as usual.
         * */
        void *MEM_mapallocN(size_t len, const char *str)
@@ -171,7 +173,8 @@ extern "C" {
        /** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */
        void MEM_set_memory_debug(void);
 
-       /** Memory usage stats
+       /**
+        * Memory usage stats
         * - MEM_get_memory_in_use is all memory
         * - MEM_get_mapped_memory_in_use is a subset of all memory */
        uintptr_t MEM_get_memory_in_use(void);
index 7eda5a3ab5e4249fb35221934d07ee9dafabb084..76df58f4a50598c1ae5cfe1962ed2f2914eaa6f5 100644 (file)
@@ -20,7 +20,8 @@
  *
  * The Original Code is: all of this file.
  *
- * Contributor(s): none yet.
+ * Contributor(s): Brecht Van Lommel
+ *                 Campbell Barton
  *
  * ***** END GPL LICENSE BLOCK *****
  */
@@ -904,6 +905,4 @@ const char *MEM_name_ptr(void *vmemh)
                return "MEM_name_ptr(NULL)";
        }
 }
-#endif
-
-/* eof */
+#endif  /* NDEBUG */
index c773cfbe68095452350f9fe9e3644492706964e3..8fd2166e6f823d7f8941a12a5f3e3a1299addd70 100644 (file)
@@ -31,7 +31,7 @@
 /** \file BLI_mempool.h
  *  \ingroup bli
  *  \author Geoffrey Bantle
- *  \brief Simple fast memory allocator.
+ *  \brief Simple fast memory allocator for fixed size chunks.
  */
 
 #ifdef __cplusplus
index c4b9d5989e16ebc9b25b3b395685cfdec66f142a..2a5739db56f8c94d3af24945cbe3424ea1ff9510 100644 (file)
@@ -27,9 +27,9 @@
 
 /** \file blender/editors/space_node/drawnode.c
  *  \ingroup spnode
+ *  \brief lower level node drawing for nodes (boarders, headers etc), also node layout.
  */
 
-
 #include <math.h>
 #include <stdio.h>
 #include <string.h>
index adf523133071c60191d5ce93294b5a2731bca067..708d7e0b5e61e65f14e7c41949ebeb628833145b 100644 (file)
@@ -26,9 +26,9 @@
 
 /** \file blender/editors/space_node/node_draw.c
  *  \ingroup spnode
+ *  \brief higher level node drawing for the node editor.
  */
 
-
 #include <math.h>
 #include <stdio.h>
 #include <string.h>