[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [35022] trunk/blender: doxygen: add guardedalloc and AVI
Nathan Letwory
nathan at letworyinteractive.com
Mon Feb 21 10:23:34 CET 2011
Revision: 35022
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=35022
Author: jesterking
Date: 2011-02-21 09:23:34 +0000 (Mon, 21 Feb 2011)
Log Message:
-----------
doxygen: add guardedalloc and AVI
Modified Paths:
--------------
trunk/blender/doc/Doxyfile
trunk/blender/doc/doxygen.main
trunk/blender/doc/footer.html
trunk/blender/intern/guardedalloc/BLO_sys_types.h
trunk/blender/intern/guardedalloc/MEM_guardedalloc.h
trunk/blender/intern/guardedalloc/mmap_win.h
trunk/blender/source/blender/avi/AVI_avi.h
Modified: trunk/blender/doc/Doxyfile
===================================================================
--- trunk/blender/doc/Doxyfile 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/doc/Doxyfile 2011-02-21 09:23:34 UTC (rev 35022)
@@ -630,7 +630,8 @@
../source/blender/nodes \
../source/blender/modifiers \
../source/blender/gpu \
- ../source/blender/avi
+ ../source/blender/avi \
+ ../intern/guardedalloc
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Modified: trunk/blender/doc/doxygen.main
===================================================================
--- trunk/blender/doc/doxygen.main 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/doc/doxygen.main 2011-02-21 09:23:34 UTC (rev 35022)
@@ -18,6 +18,10 @@
* as part of the normal development process.
*/
+/** \defgroup MEM Guarded memory (de)allocation
+ * \ingroup intern
+ */
+
/** \defgroup extern External libraries
* \section externabout External libraries
* As with \ref intern these libraries are
Modified: trunk/blender/doc/footer.html
===================================================================
--- trunk/blender/doc/footer.html 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/doc/footer.html 2011-02-21 09:23:34 UTC (rev 35022)
@@ -1,5 +1,5 @@
<hr class="footer"/><address class="footer"><small>Generated on $datetime for $projectname by
<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> $doxygenversion </small></address>
+doxygen</a> $doxygenversion </small></address>
</body>
</html>
Modified: trunk/blender/intern/guardedalloc/BLO_sys_types.h
===================================================================
--- trunk/blender/intern/guardedalloc/BLO_sys_types.h 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/intern/guardedalloc/BLO_sys_types.h 2011-02-21 09:23:34 UTC (rev 35022)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -42,6 +42,11 @@
// but is not allowed be accessed here because of bad-level-call
*/
+/** \file BLO_sys_types.h
+ * \ingroup MEM
+ * \todo solve naming issue BLO -> MEM
+ */
+
#ifndef BLO_SYS_TYPES_H
#define BLO_SYS_TYPES_H
Modified: trunk/blender/intern/guardedalloc/MEM_guardedalloc.h
===================================================================
--- trunk/blender/intern/guardedalloc/MEM_guardedalloc.h 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/intern/guardedalloc/MEM_guardedalloc.h 2011-02-21 09:23:34 UTC (rev 35022)
@@ -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 @@
/** 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
Modified: trunk/blender/intern/guardedalloc/mmap_win.h
===================================================================
--- trunk/blender/intern/guardedalloc/mmap_win.h 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/intern/guardedalloc/mmap_win.h 2011-02-21 09:23:34 UTC (rev 35022)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
+
+/** \file mmap_win.h
+ * \ingroup MEM
+ * \author Andrea Weikert
+ */
#ifndef MMAP_WIN_H
#define MMAP_WIN_H
Modified: trunk/blender/source/blender/avi/AVI_avi.h
===================================================================
--- trunk/blender/source/blender/avi/AVI_avi.h 2011-02-21 09:09:27 UTC (rev 35021)
+++ trunk/blender/source/blender/avi/AVI_avi.h 2011-02-21 09:23:34 UTC (rev 35022)
@@ -1,24 +1,4 @@
-/**
- * @mainpage AVI - AVI module external interface
- *
- * @section about About the AVI module
- *
- * This is external code. It provides avi file import/export and
- * conversions. It has been adapted to make use of Blender memory
- * management functions, and because of this it needs module
- * blenlib. You need to provide this lib when linking with libavi.a .
- *
- * @section issues Known issues with AVI
- *
- * - avi uses mallocN, freeN from blenlib.
- * - Not all functions that are used externally are properly
- * prototyped.
- *
- * This header has not been split, since it interleaves type defines
- * and functions. You would need the types to be able to include the
- * function headers anyway. And, after all, it is someone else's
- * code. So we keep it like this.
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -48,6 +28,30 @@
*
*/
+/** \file AVI_avi.h
+ * \ingroup avi
+ * \section aviabout AVI module external interface
+ *
+ * \subsection about About the AVI module
+ *
+ * This is external code. It provides avi file import/export and
+ * conversions. It has been adapted to make use of Blender memory
+ * management functions, and because of this it needs module
+ * blenlib. You need to provide this lib when linking with libavi.a .
+ *
+ * \subsection issues Known issues with AVI
+ *
+ * - avi uses mallocN, freeN from blenlib.
+ * - Not all functions that are used externally are properly
+ * prototyped.
+ *
+ * This header has not been split, since it interleaves type defines
+ * and functions. You would need the types to be able to include the
+ * function headers anyway. And, after all, it is someone else's
+ * code. So we keep it like this.
+ *
+ */
+
#ifndef __AVI_H__
#define __AVI_H__
More information about the Bf-blender-cvs
mailing list