diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-08-01 05:36:14 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-08-01 05:37:52 +0300 |
commit | 49f88326af63a0197299e217748ce1379b5a5830 (patch) | |
tree | b8f7c1e6d78081c14641db8c2797321ab0e3e0e8 /source/blender | |
parent | 1c626f823db0136317ee867dde0c778ab785070c (diff) |
Docs: doxy cleanup/minor edits
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/blenkernel/BKE_DerivedMesh.h | 2 | ||||
-rw-r--r-- | source/blender/blenkernel/BKE_editmesh.h | 14 | ||||
-rw-r--r-- | source/blender/bmesh/bmesh.h | 11 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_walkers_impl.c | 2 | ||||
-rw-r--r-- | source/blender/editors/armature/reeb.h | 3 |
5 files changed, 17 insertions, 15 deletions
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h index 6a6e975bc72..2eac1a07daf 100644 --- a/source/blender/blenkernel/BKE_DerivedMesh.h +++ b/source/blender/blenkernel/BKE_DerivedMesh.h @@ -228,7 +228,7 @@ struct DerivedMesh { int (*getNumPolys)(DerivedMesh *dm); /** Copy a single vert/edge/tessellated face from the derived mesh into - * *{vert/edge/face}_r. note that the current implementation + * ``*r_{vert/edge/face}``. note that the current implementation * of this function can be quite slow, iterating over all * elements (editmesh) */ diff --git a/source/blender/blenkernel/BKE_editmesh.h b/source/blender/blenkernel/BKE_editmesh.h index d350eea7ac7..55a9db9b1e5 100644 --- a/source/blender/blenkernel/BKE_editmesh.h +++ b/source/blender/blenkernel/BKE_editmesh.h @@ -25,6 +25,10 @@ /** \file BKE_editmesh.h * \ingroup bke + * + * The \link edmesh EDBM module\endlink is for editmode bmesh stuff. + * In contrast, the this module is for code shared with blenkernel thats + * only concerned with low level operations on the #BMEditMesh structure. */ #include "BKE_customdata.h" @@ -37,14 +41,10 @@ struct Scene; struct DerivedMesh; struct MeshStatVis; -/* ok: the EDBM module is for editmode bmesh stuff. in contrast, the - * BMEdit module is for code shared with blenkernel that concerns - * the BMEditMesh structure. - */ - -/* this structure replaces EditMesh. +/** + * This structure is used for mesh edit-mode. * - * through this, you get access to both the edit bmesh, + * through this, you get access to both the edit #BMesh, * it's tessellation, and various stuff that doesn't belong in the BMesh * struct itself. * diff --git a/source/blender/bmesh/bmesh.h b/source/blender/bmesh/bmesh.h index 9bb7bc33e29..0595a867ac2 100644 --- a/source/blender/bmesh/bmesh.h +++ b/source/blender/bmesh/bmesh.h @@ -28,8 +28,7 @@ * * \addtogroup bmesh BMesh * - * \brief BMesh is a non-manifold boundary representation designed to replace the current, limited EditMesh structure, - * solving many of the design limitations and maintenance issues of EditMesh. + * \brief BMesh is a non-manifold boundary representation designed to support advanced editing operations. * * * \section bm_structure The Structure @@ -78,11 +77,11 @@ * * \subsection bm_edges_and_verts Edges and Vertices * - * Edges and Vertices in BMesh are much like their counterparts in EditMesh, - * except for some members private to the BMesh api. + * Edges and Vertices in BMesh are primitive structures. * - * \note There can be more than one edge between two vertices in bmesh, - * though the rest of blender (e.g. DerivedMesh, CDDM, CCGSubSurf, etc) does not support this. + * \note There can be more than one edge between two vertices in BMesh, + * though the rest of Blender (e.g. DerivedMesh, CDDM, CCGSubSurf, etc) does not support this. + * So it should only occur temporarily during editing operations. * * * \subsection bm_queries Queries diff --git a/source/blender/bmesh/intern/bmesh_walkers_impl.c b/source/blender/bmesh/intern/bmesh_walkers_impl.c index 23a9f68dc98..b38c99d2240 100644 --- a/source/blender/bmesh/intern/bmesh_walkers_impl.c +++ b/source/blender/bmesh/intern/bmesh_walkers_impl.c @@ -1232,7 +1232,7 @@ static void *bmw_FaceLoopWalker_step(BMWalker *walker) * * Starts at a tool-flagged edge and walks over the edge ring * Conditions for starting and stepping the edge ring have been - * tuned in an attempt to match the edge rings built by EditMesh + * tuned to match behavior users expect (dating back to v2.4x). */ static void bmw_EdgeringWalker_begin(BMWalker *walker, void *data) { diff --git a/source/blender/editors/armature/reeb.h b/source/blender/editors/armature/reeb.h index b0e1fd3ae34..a6ef16fed67 100644 --- a/source/blender/editors/armature/reeb.h +++ b/source/blender/editors/armature/reeb.h @@ -140,6 +140,7 @@ typedef struct ReebArcIterator { int stride; } ReebArcIterator; +#if 0 struct EditMesh; struct EdgeIndex; @@ -152,6 +153,8 @@ void arcToVCol(struct ReebGraph *rg, struct EditMesh *em, int index); void renormalizeWeight(struct EditMesh *em, float newmax); ReebGraph *generateReebGraph(struct EditMesh *me, int subdivisions); +#endif + ReebGraph *newReebGraph(void); void initArcIterator(BArcIterator *iter, struct ReebArc *arc, struct ReebNode *head); |