diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-02-29 10:55:10 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-02-29 10:55:10 +0400 |
commit | a6f420b82888ca6ef2f919e6dfed2343fa349117 (patch) | |
tree | 696eea7b35312b243b61f3943fc13e2c66de8318 /source/blender/bmesh/intern/bmesh_marking.c | |
parent | b18794c3b67e75fc4eedcfed45686cc1efa279e8 (diff) |
update doxygen comments for bmesh.
Diffstat (limited to 'source/blender/bmesh/intern/bmesh_marking.c')
-rw-r--r-- | source/blender/bmesh/intern/bmesh_marking.c | 57 |
1 files changed, 22 insertions, 35 deletions
diff --git a/source/blender/bmesh/intern/bmesh_marking.c b/source/blender/bmesh/intern/bmesh_marking.c index a774c1a9ecc..7d64d00e26e 100644 --- a/source/blender/bmesh/intern/bmesh_marking.c +++ b/source/blender/bmesh/intern/bmesh_marking.c @@ -40,18 +40,6 @@ #include "bmesh.h" - -/* - * BMESH SELECTMODE FLUSH - * - * Makes sure to flush selections - * 'upwards' (ie: all verts of an edge - * selects the edge and so on). This - * should only be called by system and not - * tool authors. - * - */ - static void recount_totsels(BMesh *bm) { BMIter iter; @@ -76,6 +64,13 @@ static void recount_totsels(BMesh *bm) } } +/** + * \brief Select Mode Flush + * + * Makes sure to flush selections 'upwards' + * (ie: all verts of an edge selects the edge and so on). + * This should only be called by system and not tool authors. + */ void BM_mesh_select_mode_flush(BMesh *bm) { BMEdge *e; @@ -243,13 +238,11 @@ void BM_mesh_select_flush(BMesh *bm) } /** - * BMESH SELECT VERT + * \brief Select Vert * * Changes selection state of a single vertex * in a mesh - * */ - void BM_vert_select_set(BMesh *bm, BMVert *v, int select) { /* BMIter iter; */ @@ -273,14 +266,11 @@ void BM_vert_select_set(BMesh *bm, BMVert *v, int select) } } -/* - * BMESH SELECT EDGE - * - * Changes selection state of a single edge - * in a mesh. +/** + * \brief Select Edge * + * Changes selection state of a single edge in a mesh. */ - void BM_edge_select_set(BMesh *bm, BMEdge *e, int select) { if (BM_elem_flag_test(e, BM_ELEM_HIDDEN)) { @@ -333,15 +323,12 @@ void BM_edge_select_set(BMesh *bm, BMEdge *e, int select) } } -/* - * - * BMESH SELECT FACE +/** + * \brief Select Face * * Changes selection state of a single * face in a mesh. - * */ - void BM_face_select_set(BMesh *bm, BMFace *f, int select) { BMLoop *l_iter; @@ -401,13 +388,12 @@ void BM_face_select_set(BMesh *bm, BMFace *f, int select) } } -/* - * BMESH SELECTMODE SET - * - * Sets the selection mode for the bmesh +/** + * Select Mode Set * + * Sets the selection mode for the bmesh, + * updating the selection state. */ - void BM_select_mode_set(BMesh *bm, int selectmode) { BMVert *v; @@ -545,13 +531,14 @@ BMFace *BM_active_face_get(BMesh *bm, int sloppy) return NULL; } -/* Generic way to get data from an EditSelection type +/** + * Generic way to get data from an EditSelection type * These functions were written to be used by the Modifier widget * when in Rotate about active mode, but can be used anywhere. * - * - EM_editselection_center - * - EM_editselection_normal - * - EM_editselection_plane + * - #EM_editselection_center + * - #EM_editselection_normal + * - #EM_editselection_plane */ void BM_editselection_center(BMesh *bm, float r_center[3], BMEditSelection *ese) { |