doxygen: add guardedalloc and AVI

1 files changed, 15 insertions, 15 deletions

diff --git a/intern/guardedalloc/MEM_guardedalloc.h b/intern/guardedalloc/MEM_guardedalloc.h
index 2276c5ef0e6..8d8557f2d31 100644
--- a/intern/guardedalloc/MEM_guardedalloc.h
+++ b/intern/guardedalloc/MEM_guardedalloc.h
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
@@ -26,32 +26,30 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/**
- * Copyright (C) 2001 NaN Technologies B.V.
- * Guarded memory (de)allocation
+/** \file MEM_guardedalloc.h
  *
+ *  \author Copyright (C) 2001 NaN Technologies B.V.
+ *  \brief Guarded memory (de)allocation
  *
- * @mainpage MEM - c-style guarded memory allocation
  *
- * @section about About the MEM module
+ * \section aboutmem c-style guarded memory allocation
+ *
+ * \subsection about About the MEM module
  *
  * MEM provides guarded malloc/calloc calls. All memory is enclosed by
  * pads, to detect out-of-bound writes. All blocks are placed in a
  * linked list, so they remain reachable at all times. There is no
  * back-up in case the linked-list related data is lost.
  *
- * @section issues Known issues with MEM
+ * \subsection issues Known issues with MEM
  *
  * There are currently no known issues with MEM. Note that there is a
  * second intern/ module with MEM_ prefix, for use in c++.
  * 
- * @section dependencies Dependencies
- *
+ * \subsection dependencies Dependencies
  * - stdlib
- *
  * - stdio
- *
- * */
+ */
 
 #ifndef MEM_MALLOCN_H
 #define MEM_MALLOCN_H
@@ -145,17 +143,19 @@ 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);
+	/** Get mapped memory usage. */
 	uintptr_t MEM_get_mapped_memory_in_use(void);
+	/** Get amount of memory blocks in use. */
 	int MEM_get_memory_blocks_in_use(void);
 
-	/*reset the peak memory statistic to zero*/
+	/** Reset the peak memory statistic to zero. */
 	void MEM_reset_peak_memory(void);
 
-	/*get the peak memory usage in bytes, including mmap allocations*/
+	/** Get the peak memory usage in bytes, including mmap allocations. */
 	uintptr_t MEM_get_peak_memory(void) WARN_UNUSED;
 
 #ifndef NDEBUG