diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-03-03 15:45:08 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-03-03 15:45:08 +0400 |
commit | 9d49fa0e6373d78c794e8472ed3f527392dfabcd (patch) | |
tree | fdbbdad43aa2c0ed8983721351b26f94e06e7c78 /source/blender/bmesh | |
parent | 1f928833f3677fa47a10099205c9f7ffa9adfadb (diff) |
style cleanup - spelling corrections & update some incorrect comments.
Diffstat (limited to 'source/blender/bmesh')
-rw-r--r-- | source/blender/bmesh/bmesh_operator_api.h | 28 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_core.c | 4 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_operators.c | 2 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_polygon.c | 2 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_walkers.h | 2 | ||||
-rw-r--r-- | source/blender/bmesh/operators/bmo_edgesplit.c | 2 |
6 files changed, 22 insertions, 18 deletions
diff --git a/source/blender/bmesh/bmesh_operator_api.h b/source/blender/bmesh/bmesh_operator_api.h index 04cca767d9e..a0e2ba325b0 100644 --- a/source/blender/bmesh/bmesh_operator_api.h +++ b/source/blender/bmesh/bmesh_operator_api.h @@ -35,7 +35,7 @@ extern "C" { #include <stdarg.h> -/* +/** * operators represent logical, executable mesh modules. all topological * operations involving a bmesh has to go through them. * @@ -55,18 +55,22 @@ extern "C" { * bmesh_opdefines.c and the BMOpDefine struct for how to define new operators. * * in general, operators are fed arrays of elements, created using either - * BM_HeaderFlag_To_Slot or BM_Flag_To_Slot (or through one of the format - * specifyers in BMO_op_callf or BMO_op_initf). Note that multiple element - * types (e.g. faces and edges) can be fed to the same slot array. Operators - * act on this data, and possibly spit out data into output slots. + * #BMO_slot_buffer_from_hflag or #BMO_slot_buffer_from_flag + * (or through one of the format specifiers in #BMO_op_callf or #BMO_op_initf). + * + * \note multiple element types (e.g. faces and edges) + * can be fed to the same slot array. Operators act on this data, + * and possibly spit out data into output slots. + * + * \note operators should never read from header flags (e.g. element->head.flag). + * For example, if you want an operator to only operate on selected faces, you + * should use #BMO_slot_buffer_from_hflag to put the selected elements into a slot. + * + * \note when you read from an element slot array or mapping, you can either tool-flag + * all the elements in it, or read them using an iterator API (which is semantically + * similar to the iterator api in bmesh_iterators.h). * - * some notes: - * - operators should never read from header flags (e.g. element->head.flag). for - * example, if you want an operator to only operate on selected faces, you - * should use BM_HeaderFlag_To_Slot to put the selected elements into a slot. - * - when you read from an element slot array or mapping, you can either tool-flag - * all the elements in it, or read them using an iterator APi (which is - * semantically similar to the iterator api in bmesh_iterators.h). + * \note only #BMLoop items can't be put into slots as with verts, edges & faces. */ struct GHashIterator; diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c index a04e5eda5a2..6a38b9a136c 100644 --- a/source/blender/bmesh/intern/bmesh_core.c +++ b/source/blender/bmesh/intern/bmesh_core.c @@ -649,7 +649,7 @@ static int bm_loop_length(BMLoop *l) * \brief Loop Reverse * * Changes the winding order of a face from CW to CCW or vice versa. - * This euler is a bit peculiar in compairson to others as it is its + * This euler is a bit peculiar in comparison to others as it is its * own inverse. * * BMESH_TODO: reinsert validation code. @@ -1096,7 +1096,7 @@ static BMFace *bm_face_create__sfme(BMesh *bm, BMFace *UNUSED(example)) * level wrapping functions (when holes are fully implemented, anyway). * * \note that holes represents which holes goes to the new face, and of - * course this requires removing them from the exitsing face first, since + * course this requires removing them from the existing face first, since * you cannot have linked list links inside multiple lists. * * \return A BMFace pointer diff --git a/source/blender/bmesh/intern/bmesh_operators.c b/source/blender/bmesh/intern/bmesh_operators.c index 911c3872161..a696808c133 100644 --- a/source/blender/bmesh/intern/bmesh_operators.c +++ b/source/blender/bmesh/intern/bmesh_operators.c @@ -679,7 +679,7 @@ static void BMO_slot_buffer_from_all(BMesh *bm, BMOperator *op, const char *slot * into a slot for an operator. */ void BMO_slot_buffer_from_hflag(BMesh *bm, BMOperator *op, const char *slotname, - const char hflag, const char htype) + const char hflag, const char htype) { BMIter elements; BMElem *ele; diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c index f6111e75e80..15a5a7d71b0 100644 --- a/source/blender/bmesh/intern/bmesh_polygon.c +++ b/source/blender/bmesh/intern/bmesh_polygon.c @@ -707,7 +707,7 @@ static int goodline(float (*projectverts)[3], BMFace *f, int v1i, * * Used by tesselator to find * the next triangle to 'clip off' - * of a polygon while tesselating. + * of a polygon while tessellating. */ static BMLoop *find_ear(BMesh *UNUSED(bm), BMFace *f, float (*verts)[3], const int nvert) { diff --git a/source/blender/bmesh/intern/bmesh_walkers.h b/source/blender/bmesh/intern/bmesh_walkers.h index 765576c9ab7..4c8830e61e3 100644 --- a/source/blender/bmesh/intern/bmesh_walkers.h +++ b/source/blender/bmesh/intern/bmesh_walkers.h @@ -103,7 +103,7 @@ enum { /* walk over connected geometry. can restrict to a search flag, * or not, it's optional. * - * takes a vert as an arugment, and spits out edges, restrict flag acts + * takes a vert as an argument, and spits out edges, restrict flag acts * on the edges as well. */ BMW_SHELL, /*walk over an edge loop. search flag doesn't do anything.*/ diff --git a/source/blender/bmesh/operators/bmo_edgesplit.c b/source/blender/bmesh/operators/bmo_edgesplit.c index 059ee882fb8..5b5eb6b4cca 100644 --- a/source/blender/bmesh/operators/bmo_edgesplit.c +++ b/source/blender/bmesh/operators/bmo_edgesplit.c @@ -386,7 +386,7 @@ void bmo_edgesplit_exec(BMesh *bm, BMOperator *op) BMO_elem_flag_enable(bm, f2, FACE_NEW); } - /* remake_face() sets invalid indecies, + /* remake_face() sets invalid indices, * likely these will be corrected on operator exit anyway */ bm->elem_index_dirty &= ~BM_EDGE; |