[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [48915] trunk/blender: header comment cleanup, explain whats the difference between confusingly named drarnode. c and node_draw.c.

[Campbell Barton]

Revision: 48915
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=48915
Author:   campbellbarton
Date:     2012-07-14 15:29:45 +0000 (Sat, 14 Jul 2012)
Log Message:
-----------
header comment cleanup, explain whats the difference between confusingly named drarnode.c and node_draw.c.

Modified Paths:
--------------
    trunk/blender/intern/guardedalloc/MEM_guardedalloc.h
    trunk/blender/intern/guardedalloc/intern/mallocn.c
    trunk/blender/source/blender/blenlib/BLI_mempool.h
    trunk/blender/source/blender/editors/space_node/drawnode.c
    trunk/blender/source/blender/editors/space_node/node_draw.c

Modified: trunk/blender/intern/guardedalloc/MEM_guardedalloc.h
===================================================================
--- trunk/blender/intern/guardedalloc/MEM_guardedalloc.h	2012-07-14 15:29:05 UTC (rev 48914)
+++ trunk/blender/intern/guardedalloc/MEM_guardedalloc.h	2012-07-14 15:29:45 UTC (rev 48915)
@@ -20,19 +20,19 @@
  *
  * 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 @@
 	__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 @@
 	__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 @@
 	/** 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);

Modified: trunk/blender/intern/guardedalloc/intern/mallocn.c
===================================================================
--- trunk/blender/intern/guardedalloc/intern/mallocn.c	2012-07-14 15:29:05 UTC (rev 48914)
+++ trunk/blender/intern/guardedalloc/intern/mallocn.c	2012-07-14 15:29:45 UTC (rev 48915)
@@ -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 @@
 		return "MEM_name_ptr(NULL)";
 	}
 }
-#endif
-
-/* eof */
+#endif  /* NDEBUG */

Modified: trunk/blender/source/blender/blenlib/BLI_mempool.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_mempool.h	2012-07-14 15:29:05 UTC (rev 48914)
+++ trunk/blender/source/blender/blenlib/BLI_mempool.h	2012-07-14 15:29:45 UTC (rev 48915)
@@ -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

Modified: trunk/blender/source/blender/editors/space_node/drawnode.c
===================================================================
--- trunk/blender/source/blender/editors/space_node/drawnode.c	2012-07-14 15:29:05 UTC (rev 48914)
+++ trunk/blender/source/blender/editors/space_node/drawnode.c	2012-07-14 15:29:45 UTC (rev 48915)
@@ -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>

Modified: trunk/blender/source/blender/editors/space_node/node_draw.c
===================================================================
--- trunk/blender/source/blender/editors/space_node/node_draw.c	2012-07-14 15:29:05 UTC (rev 48914)
+++ trunk/blender/source/blender/editors/space_node/node_draw.c	2012-07-14 15:29:45 UTC (rev 48915)
@@ -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>