[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [44622] trunk/blender/source/blender: style cleanup / comment formatting for bli/bke/bmesh

Campbell Barton ideasman42 at gmail.com
Sat Mar 3 21:19:25 CET 2012 

Revision: 44622
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=44622
Author:   campbellbarton
Date:     2012-03-03 20:19:11 +0000 (Sat, 03 Mar 2012)
Log Message:
-----------
style cleanup / comment formatting for bli/bke/bmesh

Modified Paths:
--------------
    trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
    trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h
    trunk/blender/source/blender/blenkernel/BKE_bvhutils.h
    trunk/blender/source/blender/blenkernel/BKE_cdderivedmesh.h
    trunk/blender/source/blender/blenkernel/BKE_cloth.h
    trunk/blender/source/blender/blenkernel/BKE_context.h
    trunk/blender/source/blender/blenkernel/BKE_customdata.h
    trunk/blender/source/blender/blenkernel/BKE_depsgraph.h
    trunk/blender/source/blender/blenkernel/BKE_dynamicpaint.h
    trunk/blender/source/blender/blenkernel/BKE_icons.h
    trunk/blender/source/blender/blenkernel/BKE_idprop.h
    trunk/blender/source/blender/blenkernel/BKE_mesh.h
    trunk/blender/source/blender/blenkernel/BKE_modifier.h
    trunk/blender/source/blender/blenkernel/BKE_particle.h
    trunk/blender/source/blender/blenkernel/BKE_screen.h
    trunk/blender/source/blender/blenkernel/BKE_suggestions.h
    trunk/blender/source/blender/blenkernel/BKE_tessmesh.h
    trunk/blender/source/blender/blenkernel/intern/CCGSubSurf.c
    trunk/blender/source/blender/blenkernel/intern/action.c
    trunk/blender/source/blender/blenkernel/intern/anim.c
    trunk/blender/source/blender/blenkernel/intern/anim_sys.c
    trunk/blender/source/blender/blenkernel/intern/armature.c
    trunk/blender/source/blender/blenkernel/intern/brush.c
    trunk/blender/source/blender/blenkernel/intern/bvhutils.c
    trunk/blender/source/blender/blenkernel/intern/colortools.c
    trunk/blender/source/blender/blenkernel/intern/curve.c
    trunk/blender/source/blender/blenkernel/intern/customdata.c
    trunk/blender/source/blender/blenkernel/intern/customdata_file.c
    trunk/blender/source/blender/blenkernel/intern/dynamicpaint.c
    trunk/blender/source/blender/blenkernel/intern/editderivedmesh.c
    trunk/blender/source/blender/blenkernel/intern/effect.c
    trunk/blender/source/blender/blenkernel/intern/fcurve.c
    trunk/blender/source/blender/blenkernel/intern/font.c
    trunk/blender/source/blender/blenkernel/intern/group.c
    trunk/blender/source/blender/blenkernel/intern/icons.c
    trunk/blender/source/blender/blenkernel/intern/idprop.c
    trunk/blender/source/blender/blenkernel/intern/image.c
    trunk/blender/source/blender/blenkernel/intern/image_gen.c
    trunk/blender/source/blender/blenkernel/intern/ipo.c
    trunk/blender/source/blender/blenkernel/intern/key.c
    trunk/blender/source/blender/blenkernel/intern/lamp.c
    trunk/blender/source/blender/blenkernel/intern/lattice.c
    trunk/blender/source/blender/blenkernel/intern/library.c
    trunk/blender/source/blender/blenkernel/intern/material.c
    trunk/blender/source/blender/blenkernel/intern/mball.c
    trunk/blender/source/blender/blenkernel/intern/mesh.c
    trunk/blender/source/blender/blenkernel/intern/mesh_validate.c
    trunk/blender/source/blender/blenkernel/intern/modifier.c
    trunk/blender/source/blender/blenkernel/intern/movieclip.c
    trunk/blender/source/blender/blenkernel/intern/node.c
    trunk/blender/source/blender/blenkernel/intern/object.c
    trunk/blender/source/blender/blenkernel/intern/ocean.c
    trunk/blender/source/blender/blenkernel/intern/packedFile.c
    trunk/blender/source/blender/blenkernel/intern/particle.c
    trunk/blender/source/blender/blenkernel/intern/particle_system.c
    trunk/blender/source/blender/blenkernel/intern/pointcache.c
    trunk/blender/source/blender/blenkernel/intern/scene.c
    trunk/blender/source/blender/blenkernel/intern/script.c
    trunk/blender/source/blender/blenkernel/intern/seqeffects.c
    trunk/blender/source/blender/blenkernel/intern/sequencer.c
    trunk/blender/source/blender/blenkernel/intern/softbody.c
    trunk/blender/source/blender/blenkernel/intern/speaker.c
    trunk/blender/source/blender/blenkernel/intern/subsurf_ccg.c
    trunk/blender/source/blender/blenkernel/intern/text.c
    trunk/blender/source/blender/blenkernel/intern/texture.c
    trunk/blender/source/blender/blenkernel/intern/tracking.c
    trunk/blender/source/blender/blenkernel/intern/unit.c
    trunk/blender/source/blender/blenkernel/intern/world.c
    trunk/blender/source/blender/blenlib/BLI_bitmap.h
    trunk/blender/source/blender/blenlib/BLI_bpath.h
    trunk/blender/source/blender/blenlib/BLI_editVert.h
    trunk/blender/source/blender/blenlib/BLI_fnmatch.h
    trunk/blender/source/blender/blenlib/BLI_heap.h
    trunk/blender/source/blender/blenlib/BLI_math_geom.h
    trunk/blender/source/blender/blenlib/BLI_math_matrix.h
    trunk/blender/source/blender/blenlib/BLI_md5.h
    trunk/blender/source/blender/blenlib/BLI_path_util.h
    trunk/blender/source/blender/blenlib/BLI_pbvh.h
    trunk/blender/source/blender/blenlib/BLI_scanfill.h
    trunk/blender/source/blender/blenlib/intern/BLI_kdopbvh.c
    trunk/blender/source/blender/blenlib/intern/boxpack2d.c
    trunk/blender/source/blender/blenlib/intern/bpath.c
    trunk/blender/source/blender/blenlib/intern/fileops.c
    trunk/blender/source/blender/blenlib/intern/freetypefont.c
    trunk/blender/source/blender/blenlib/intern/math_color.c
    trunk/blender/source/blender/blenlib/intern/math_color_inline.c
    trunk/blender/source/blender/blenlib/intern/math_geom.c
    trunk/blender/source/blender/blenlib/intern/math_matrix.c
    trunk/blender/source/blender/blenlib/intern/math_rotation.c
    trunk/blender/source/blender/blenlib/intern/math_vector.c
    trunk/blender/source/blender/blenlib/intern/math_vector_inline.c
    trunk/blender/source/blender/blenlib/intern/noise.c
    trunk/blender/source/blender/blenlib/intern/path_util.c
    trunk/blender/source/blender/blenlib/intern/pbvh.c
    trunk/blender/source/blender/blenlib/intern/scanfill.c
    trunk/blender/source/blender/blenlib/intern/storage.c
    trunk/blender/source/blender/blenlib/intern/string.c
    trunk/blender/source/blender/blenlib/intern/string_utf8.c
    trunk/blender/source/blender/blenlib/intern/threads.c
    trunk/blender/source/blender/blenlib/intern/winstuff.c
    trunk/blender/source/blender/bmesh/intern/bmesh_core.c
    trunk/blender/source/blender/bmesh/intern/bmesh_iterators.h
    trunk/blender/source/blender/bmesh/intern/bmesh_polygon.c
    trunk/blender/source/blender/bmesh/intern/bmesh_walkers.h
    trunk/blender/source/blender/bmesh/operators/bmo_triangulate.c
    trunk/blender/source/blender/bmesh/operators/bmo_utils.c

Modified: trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h	2012-03-03 16:31:46 UTC (rev 44621)
+++ trunk/blender/source/blender/blenkernel/BKE_DerivedMesh.h	2012-03-03 20:19:11 UTC (rev 44622)
@@ -29,37 +29,37 @@
 #define __BKE_DERIVEDMESH_H__
 
 /*
-  Basic design of the DerivedMesh system:
+ * 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.
+ * 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 
+ * one format to another.
+ *
+ * All Mesh structures in blender make use of CustomData, which is used to store
+ * per-element attributes and interpolate them (e.g. uvs, vcols, vgroups, etc).
+ * 
+ * Mesh is the "serialized" structure, used for storing object-mode mesh data
+ * and also for saving stuff to disk.  It's interfaces are also what DerivedMesh
+ * uses to communicate with.
+ * 
+ * CDDM is a little mesh library, that uses Mesh data structures in the backend.
+ * It's mostly used for modifiers, and has the advantages of not taking much
+ * resources.
+ *
+ * BMesh is a full-on brep, used for editmode, some modifiers, etc.  It's much
+ * more capable (if memory-intensive) then CDDM.
+ *
+ * DerivedMesh is somewhat hackish.  Many places assumes that a DerivedMesh is
+ * a CDDM (most of the time by simply copying it and converting it to one).
+ * CDDM is the original structure for modifiers, but has since been superseded
+ * by BMesh, at least for the foreseeable future.
+ */
 
-  DerivedMesh is a common set of interfaces for mesh systems.
-
-  There are three main mesh data structures in Blender: Mesh, CDDM, 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 
-  one format to another.
-
-  All Mesh structures in blender make use of CustomData, which is used to store
-  per-element attributes and interpolate them (e.g. uvs, vcols, vgroups, etc).
-  
-  Mesh is the "serialized" structure, used for storing object-mode mesh data
-  and also for saving stuff to disk.  It's interfaces are also what DerivedMesh
-  uses to communicate with.
-  
-  CDDM is a little mesh library, that uses Mesh data structures in the backend.
-  It's mostly used for modifiers, and has the advantages of not taking much
-  resources.
-
-  BMesh is a full-on brep, used for editmode, some modifiers, etc.  It's much
-  more capable (if memory-intensive) then CDDM.
-
-  DerivedMesh is somewhat hackish.  Many places assumes that a DerivedMesh is
-  a CDDM (most of the time by simply copying it and converting it to one).
-  CDDM is the original structure for modifiers, but has since been superseded
-  by BMesh, at least for the foreseeable future.
-*/
-
-/* 
+/*
  * Note: This sturcture is read-only, for all practical purposes.
  *       At some point in the future, we may want to consider
  *       creating a replacement structure that implements a proper
@@ -98,9 +98,9 @@
 #define SUB_ELEMS_FACE 50
 
 /*
-Note: all mface interfaces now officially operate on tesselated data.
-      Also, the mface origindex layer indexes mpolys, not mfaces.
-*/
+ * Note: all mface interfaces now officially operate on tesselated data.
+ *       Also, the mface origindex layer indexes mpolys, not mfaces.
+ */
 
 typedef struct DMGridData {
 	float co[3];
@@ -199,8 +199,8 @@
 	void *(*getEdgeDataArray)(DerivedMesh *dm, int type);
 	void *(*getTessFaceDataArray)(DerivedMesh *dm, int type);
 	
-	/*retrieves the base CustomData structures for 
-	  verts/edges/tessfaces/loops/facdes*/
+	/* retrieves the base CustomData structures for 
+	 * verts/edges/tessfaces/loops/facdes*/
 	CustomData *(*getVertDataLayout)(DerivedMesh *dm);
 	CustomData *(*getEdgeDataLayout)(DerivedMesh *dm);
 	CustomData *(*getTessFaceDataLayout)(DerivedMesh *dm);
@@ -576,8 +576,8 @@
 void vDM_ColorBand_store(struct ColorBand *coba);
 
 /* Simple function to get me->totvert amount of vertices/normals,
-   correctly deformed and subsurfered. Needed especially when vertexgroups are involved.
-   In use now by vertex/weigt paint and particles */
+ * correctly deformed and subsurfered. Needed especially when vertexgroups are involved.
+ * In use now by vertex/weigt paint and particles */
 float *mesh_get_mapped_verts_nors(struct Scene *scene, struct Object *ob);
 
 	/* */
@@ -625,7 +625,7 @@
 	CustomDataMask dataMask, int build_shapekey_layers);
 
 /* returns an array of deform matrices for crazyspace correction, and the
-   number of modifiers left */
+ * number of modifiers left */
 int editbmesh_get_first_deform_matrices(struct Scene *, struct Object *, struct BMEditMesh *em,
 									   float (**deformmats)[3][3], float (**deformcos)[3]);
 

Modified: trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h	2012-03-03 16:31:46 UTC (rev 44621)
+++ trunk/blender/source/blender/blenkernel/BKE_bmfont_types.h	2012-03-03 20:19:11 UTC (rev 44622)
@@ -34,10 +34,11 @@
  */
 #define is_power_of_two(N) ((N ^ (N - 1)) == (2 * N - 1))
 /*
-Moved to IMB_imbuf_types.h where it will live close to the ImBuf type.
-It is used as a userflag bit mask.
-#define IB_BITMAPFONT 1
-*/
+ * Moved to IMB_imbuf_types.h where it will live close to the ImBuf type.
+ * It is used as a userflag bit mask.
+ */
+// #define IB_BITMAPFONT 1
+
 typedef struct bmGlyph {
 	unsigned short unicode;
 	short locx, locy;

Modified: trunk/blender/source/blender/blenkernel/BKE_bvhutils.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_bvhutils.h	2012-03-03 16:31:46 UTC (rev 44621)
+++ trunk/blender/source/blender/blenkernel/BKE_bvhutils.h	2012-03-03 20:19:11 UTC (rev 44622)
@@ -106,8 +106,8 @@
 void free_bvhtree_from_mesh(struct BVHTreeFromMesh *data);
 
 /*
-* Math functions used by callbacks
-*/
+ * Math functions used by callbacks
+ */
 float bvhtree_ray_tri_intersection(const BVHTreeRay *ray, const float m_dist, const float v0[3], const float v1[3], const float v2[3]);
 float nearest_point_in_tri_surface(const float v0[3], const float v1[3], const float v2[3], const float p[3], int *v, int *e, float nearest[3]);
 

Modified: trunk/blender/source/blender/blenkernel/BKE_cdderivedmesh.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_cdderivedmesh.h	2012-03-03 16:31:46 UTC (rev 44621)
+++ trunk/blender/source/blender/blenkernel/BKE_cdderivedmesh.h	2012-03-03 20:19:11 UTC (rev 44622)
@@ -50,9 +50,9 @@
 int CDDM_Check(struct DerivedMesh *dm);
 
 /* creates a CDDerivedMesh from the given Mesh, this will reference the
-   original data in Mesh, but it is safe to apply vertex coordinates or
-   calculate normals as those functions will automtically create new
-   data to not overwrite the original */
+ * original data in Mesh, but it is safe to apply vertex coordinates or
+ * calculate normals as those functions will automtically create new
+ * data to not overwrite the original */
 struct DerivedMesh *CDDM_from_mesh(struct Mesh *mesh, struct Object *ob);
 
 /* creates a CDDerivedMesh from the given BMEditMesh */
@@ -107,7 +107,7 @@
 void CDDM_calc_edges_tessface(struct DerivedMesh *dm);
 
 /* same as CDDM_calc_edges_tessface only makes edges from ngon faces instead of tessellation
-   faces*/
+ * faces*/
 void CDDM_calc_edges(struct DerivedMesh *dm);
 
 /* reconstitute face triangulation */
@@ -143,9 +143,9 @@
 struct MLoop *CDDM_get_loops(struct DerivedMesh *dm);
 struct MPoly *CDDM_get_polys(struct DerivedMesh *dm);
 
-/*Assigns news m*** layers to the cddm.  Note that you must handle
-  freeing the old ones yourself.  Also you must ensure dm->num****Data
-  is correct.*/
+/* Assigns news m*** layers to the cddm.  Note that you must handle
+ * freeing the old ones yourself.  Also you must ensure dm->num****Data
+ * is correct.*/
 void CDDM_set_mvert(struct DerivedMesh *dm, struct MVert *mvert);
 void CDDM_set_medge(struct DerivedMesh *dm, struct MEdge *medge);
 void CDDM_set_mface(struct DerivedMesh *dm, struct MFace *mface);

Modified: trunk/blender/source/blender/blenkernel/BKE_cloth.h
===================================================================
--- trunk/blender/source/blender/blenkernel/BKE_cloth.h	2012-03-03 16:31:46 UTC (rev 44621)
+++ trunk/blender/source/blender/blenkernel/BKE_cloth.h	2012-03-03 20:19:11 UTC (rev 44622)
@@ -51,7 +51,7 @@
 #define SOFTGOALSNAP  0.999f
 
 /* This is approximately the smallest number that can be
-* represented by a float, given its precision. */
+ * represented by a float, given its precision. */
 #define ALMOST_ZERO		FLT_EPSILON
 
 /* Bits to or into the ClothVertex.flags. */
@@ -60,15 +60,15 @@
 #define CLOTH_VERT_FLAG_PINNED_EM 3
 
 /**
-* This structure describes a cloth object against which the
-* simulation can run.
-*
-* The m and n members of this structure represent the assumed
-* rectangular ordered grid for which the original paper is written.
-* At some point they need to disappear and we need to determine out
-* own connectivity of the mesh based on the actual edges in the mesh.
-*
-**/
+ * This structure describes a cloth object against which the
+ * simulation can run.
+ *
+ * The m and n members of this structure represent the assumed
+ * rectangular ordered grid for which the original paper is written.
+ * At some point they need to disappear and we need to determine out
+ * own connectivity of the mesh based on the actual edges in the mesh.
+ *
+ */
 typedef struct Cloth
 {
 	struct ClothVertex	*verts;			/* The vertices that represent this cloth. */
@@ -237,7 +237,7 @@
 
 
 /* This structure defines how to call the solver.
-*/
+ */
 typedef struct
 {
 	const char		*name;

Modified: trunk/blender/source/blender/blenkernel/BKE_context.h
===================================================================

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-blender-cvs mailing list