Revision: 48341
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=48341
Author: campbellbarton
Date: 2012-06-27 17:48:39 +0000 (Wed, 27 Jun 2012)
Log Message:
-----------
style cleanup: header comments, use more doxy compat formatting
Modified Paths:
--------------
trunk/blender/intern/guardedalloc/MEM_guardedalloc.h
trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
Modified: trunk/blender/intern/guardedalloc/MEM_guardedalloc.h
===================================================================
--- trunk/blender/intern/guardedalloc/MEM_guardedalloc.h 2012-06-27
17:08:12 UTC (rev 48340)
+++ trunk/blender/intern/guardedalloc/MEM_guardedalloc.h 2012-06-27
17:48:39 UTC (rev 48341)
@@ -97,10 +97,10 @@
void *MEM_dupallocN(void *vmemh) WARN_UNUSED;
/**
- * Reallocates a block of memory, and returns pointer to the newly
- * allocated block, the old one is freed. this is not as optimized
- * as a system realloc but just makes a new allocation and copies
- * over from existing memory. */
+ * Reallocates a block of memory, and returns pointer to the newly
+ * allocated block, the old one is freed. this is not as optimized
+ * as a system realloc but just makes a new allocation and copies
+ * over from existing memory. */
void *MEM_reallocN(void *vmemh, size_t len) WARN_UNUSED;
/**
@@ -110,13 +110,13 @@
void *MEM_callocN(size_t len, const char * str) WARN_UNUSED;
/** 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
!
- * */
+ * name must be a static, because only a pointer to it is stored !
+ * */
void *MEM_mallocN(size_t len, const char * str) WARN_UNUSED;
/** Same as callocN, clears memory and uses mmap (disk cached) if
supported.
- Can be free'd with MEM_freeN as usual.
- * */
+ * Can be free'd with MEM_freeN as usual.
+ * */
void *MEM_mapallocN(size_t len, const char * str) WARN_UNUSED;
/** Print a list of the names and sizes of all allocated memory
@@ -143,7 +143,7 @@
int MEM_check_memory_integrity(void);
/** Set thread locking functions for safe memory allocation from
multiple
- threads, pass NULL pointers to disable thread locking again. */
+ * threads, pass NULL pointers to disable thread locking again. */
void MEM_set_lock_callback(void (*lock)(void), void (*unlock)(void));
/** Attempt to enforce OSX (or other OS's) to have malloc and stack
nonzero */
@@ -195,4 +195,3 @@
#endif
#endif
-
Modified: trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h 2012-06-27
17:08:12 UTC (rev 48340)
+++ trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h 2012-06-27
17:48:39 UTC (rev 48341)
@@ -28,12 +28,14 @@
#ifndef __BKE_DERIVEDMESH_H__
#define __BKE_DERIVEDMESH_H__
-/*
+/**
* Basic design of the DerivedMesh system:
*
* DerivedMesh is a common set of interfaces for mesh systems.
*
- * There are three main mesh data structures in Blender: Mesh, CDDM, and BMesh.
+ * There are three main mesh data structures in Blender:
+ * #Mesh, #CDDerivedMesh and #BMesh.
+ *
* These, and a few others, all implement DerivedMesh interfaces,
* which contains unified drawing interfaces, a few utility interfaces,
* and a bunch of read-only interfaces intended mostly for conversion from
@@ -67,7 +69,6 @@
* as it is and stick with using BMesh and CDDM.
*/
-
#include "DNA_customdata_types.h"
#include "DNA_meshdata_types.h"
@@ -151,7 +152,7 @@
typedef struct DerivedMesh DerivedMesh;
struct DerivedMesh {
- /* Private DerivedMesh data, only for internal DerivedMesh use */
+ /** Private DerivedMesh data, only for internal DerivedMesh use */
CustomData vertData, edgeData, faceData, loopData, polyData;
int numVertData, numEdgeData, numTessFaceData, numLoopData, numPolyData;
int needsFree; /* checked on ->release, is set to 0 for cached results
*/
@@ -162,10 +163,10 @@
float auto_bump_scale;
DMDirtyFlag dirty;
- /* calculate vert and face normals */
+ /** Calculate vert and face normals */
void (*calcNormals)(DerivedMesh *dm);
- /* recalculates mesh tessellation */
+ /** Recalculates mesh tessellation */
void (*recalcTessellation)(DerivedMesh *dm);
/* Misc. Queries */
@@ -177,7 +178,7 @@
int (*getNumLoops)(DerivedMesh *dm);
int (*getNumPolys)(DerivedMesh *dm);
- /* copy a single vert/edge/tessellated face from the derived mesh into
+ /** Copy a single vert/edge/tessellated face from the derived mesh into
* *{vert/edge/face}_r. note that the current implementation
* of this function can be quite slow, iterating over all
* elements (editmesh)
@@ -186,7 +187,7 @@
void (*getEdge)(DerivedMesh *dm, int index, struct MEdge *edge_r);
void (*getTessFace)(DerivedMesh *dm, int index, struct MFace *face_r);
- /* return a pointer to the entire array of verts/edges/face from the
+ /** Return a pointer to the entire array of verts/edges/face from the
* derived mesh. if such an array does not exist yet, it will be
created,
* and freed on the next ->release(). consider using getVert/Edge/Face
if
* you are only interested in a few verts/edges/faces.
@@ -197,7 +198,7 @@
struct MLoop *(*getLoopArray)(DerivedMesh * dm);
struct MPoly *(*getPolyArray)(DerivedMesh * dm);
- /* copy all verts/edges/faces from the derived mesh into
+ /** Copy all verts/edges/faces from the derived mesh into
* *{vert/edge/face}_r (must point to a buffer large enough)
*/
void (*copyVertArray)(DerivedMesh *dm, struct MVert *vert_r);
@@ -206,7 +207,7 @@
void (*copyLoopArray)(DerivedMesh *dm, struct MLoop *loop_r);
void (*copyPolyArray)(DerivedMesh *dm, struct MPoly *poly_r);
- /* return a copy of all verts/edges/faces from the derived mesh
+ /** Return a copy of all verts/edges/faces from the derived mesh
* it is the caller's responsibility to free the returned pointer
*/
struct MVert *(*dupVertArray)(DerivedMesh * dm);
@@ -215,7 +216,7 @@
struct MLoop *(*dupLoopArray)(DerivedMesh * dm);
struct MPoly *(*dupPolyArray)(DerivedMesh * dm);
- /* return a pointer to a single element of vert/edge/face custom data
+ /** Return a pointer to a single element of vert/edge/face custom data
* from the derived mesh (this gives a pointer to the actual data, not
* a copy)
*/
@@ -223,7 +224,7 @@
void *(*getEdgeData)(DerivedMesh * dm, int index, int type);
void *(*getTessFaceData)(DerivedMesh * dm, int index, int type);
- /* return a pointer to the entire array of vert/edge/face custom data
+ /** Return a pointer to the entire array of vert/edge/face custom data
* from the derived mesh (this gives a pointer to the actual data, not
* a copy)
*/
@@ -231,7 +232,7 @@
void *(*getEdgeDataArray)(DerivedMesh * dm, int type);
void *(*getTessFaceDataArray)(DerivedMesh * dm, int type);
- /* retrieves the base CustomData structures for
+ /** Retrieves the base CustomData structures for
* verts/edges/tessfaces/loops/facdes*/
CustomData *(*getVertDataLayout)(DerivedMesh * dm);
CustomData *(*getEdgeDataLayout)(DerivedMesh * dm);
@@ -239,12 +240,12 @@
CustomData *(*getLoopDataLayout)(DerivedMesh * dm);
CustomData *(*getPolyDataLayout)(DerivedMesh * dm);
- /*copies all customdata for an element source into dst at index dest*/
+ /** Copies all customdata for an element source into dst at index dest
*/
void (*copyFromVertCData)(DerivedMesh *dm, int source, CustomData *dst,
int dest);
void (*copyFromEdgeCData)(DerivedMesh *dm, int source, CustomData *dst,
int dest);
void (*copyFromFaceCData)(DerivedMesh *dm, int source, CustomData *dst,
int dest);
- /* optional grid access for subsurf */
+ /** Optional grid access for subsurf */
int (*getNumGrids)(DerivedMesh *dm);
int (*getGridSize)(DerivedMesh *dm);
struct CCGElem **(*getGridData)(DerivedMesh * dm);
@@ -255,7 +256,7 @@
unsigned int **(*getGridHidden)(DerivedMesh * dm);
- /* Iterate over each mapped vertex in the derived mesh, calling the
+ /** Iterate over each mapped vertex in the derived mesh, calling the
* given function with the original vert and the mapped vert's new
* coordinate and normal. For historical reasons the normal can be
* passed as a float or short array, only one should be non-NULL.
@@ -265,7 +266,7 @@
const float no_f[3], const short
no_s[3]),
void *userData);
- /* Iterate over each mapped edge in the derived mesh, calling the
+ /** Iterate over each mapped edge in the derived mesh, calling the
* given function with the original edge and the mapped edge's new
* coordinates.
*/
@@ -274,7 +275,7 @@
const float v0co[3], const float
v1co[3]),
void *userData);
- /* Iterate over each mapped face in the derived mesh, calling the
+ /** Iterate over each mapped face in the derived mesh, calling the
* given function with the original face and the mapped face's (or
* faces') center and normal.
*/
@@ -283,51 +284,51 @@
const float cent[3], const
float no[3]),
void *userData);
- /* Iterate over all vertex points, calling DO_MINMAX with given args.
+ /** Iterate over all vertex points, calling DO_MINMAX with given args.
*
* Also called in Editmode
*/
void (*getMinMax)(DerivedMesh *dm, float min_r[3], float max_r[3]);
- /* Direct Access Operations */
- /* o Can be undefined */
- /* o Must be defined for modifiers that only deform however */
+ /** Direct Access Operations
+ * - Can be undefined
+ * - Must be defined for modifiers that only deform however */
- /* Get vertex location, undefined if index is not valid */
+ /** Get vertex location, undefined if index is not valid */
void (*getVertCo)(DerivedMesh *dm, int index, float co_r[3]);
- /* Fill the array (of length .getNumVerts()) with all vertex locations
*/
+ /** Fill the array (of length .getNumVerts()) with all vertex locations
*/
void (*getVertCos)(DerivedMesh *dm, float (*cos_r)[3]);
- /* Get smooth vertex normal, undefined if index is not valid */
+ /** Get smooth vertex normal, undefined if index is not valid */
void (*getVertNo)(DerivedMesh *dm, int index, float no_r[3]);
- /* Get a map of vertices to faces
+ /** Get a map of vertices to faces
*/
const struct MeshElemMap *(*getPolyMap)(struct Object *ob, DerivedMesh
*dm);
- /* Get the BVH used for paint modes
+ /** Get the BVH used for paint modes
*/
struct PBVH *(*getPBVH)(struct Object *ob, DerivedMesh *dm);
/* Drawing Operations */
- /* Draw all vertices as bgl points (no options) */
+ /** Draw all vertices as bgl points (no options) */
@@ Diff output truncated at 10240 characters. @@
_______________________________________________
Bf-blender-cvs mailing list
[email protected]
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
