header comment cleanup, explain whats the difference between confusingly named drarnode.c and node_draw.c.

This commit is contained in:
Campbell Barton 2012-07-14 15:29:45 +00:00
parent fc3cd6eb80
commit e4cfcdc3a6
5 changed files with 22 additions and 20 deletions

@ -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 @@ 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);

@ -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 */

@ -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

@ -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>

@ -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>