[Bf-blender-cvs] [49f8832] master: Docs: doxy cleanup/minor edits
Campbell Barton
noreply at git.blender.org
Sat Aug 1 04:47:12 CEST 2015
Commit: 49f88326af63a0197299e217748ce1379b5a5830
Author: Campbell Barton
Date: Sat Aug 1 12:36:14 2015 +1000
Branches: master
https://developer.blender.org/rB49f88326af63a0197299e217748ce1379b5a5830
Docs: doxy cleanup/minor edits
===================================================================
M doc/doxygen/doxygen.main.h
M doc/doxygen/doxygen.source.h
M source/blender/blenkernel/BKE_DerivedMesh.h
M source/blender/blenkernel/BKE_editmesh.h
M source/blender/bmesh/bmesh.h
M source/blender/bmesh/intern/bmesh_walkers_impl.c
M source/blender/editors/armature/reeb.h
M source/blenderplayer/bad_level_call_stubs/stubs.c
===================================================================
diff --git a/doc/doxygen/doxygen.main.h b/doc/doxygen/doxygen.main.h
index 7f63764..d282576 100644
--- a/doc/doxygen/doxygen.main.h
+++ b/doc/doxygen/doxygen.main.h
@@ -7,7 +7,7 @@
* These pages document the source code of blender.
*
* \subsection implinks Important Links
- * - <a href="http://developer.blender.org">developer.blender.org</a> with bug tracker
+ * - <a href="http://developer.blender.org">developer.blender.org</a> with bug tracker.
* - <a href="http://wiki.blender.org/index.php/Dev:Contents">Development documents</a> on our wiki.
*
* \subsection blother Other
diff --git a/doc/doxygen/doxygen.source.h b/doc/doxygen/doxygen.source.h
index 42516b9..1a77a37 100644
--- a/doc/doxygen/doxygen.source.h
+++ b/doc/doxygen/doxygen.source.h
@@ -11,7 +11,6 @@
/** \defgroup bmesh BMesh
* \ingroup blender
*/
-/** \defgroup texture Texturing */
/** \defgroup compositor Compositing */
/** \defgroup python Python
@@ -322,7 +321,7 @@
* \ingroup gui
*/
-/** \defgroup externformats external formats */
+/** \defgroup externformats External Formats */
/** \defgroup collada COLLADA
* \ingroup externformats
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h
index 6a6e975..2eac1a0 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 d350eea..55a9db9 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 9bb7bc3..0595a86 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 23a9f68..b38c99d 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 b0e1fd3..a6ef16f 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);
diff --git a/source/blenderplayer/bad_level_call_stubs/stubs.c b/source/blenderplayer/bad_level_call_stubs/stubs.c
index 952ec08..5e5e29a 100644
--- a/source/blenderplayer/bad_level_call_stubs/stubs.c
+++ b/source/blenderplayer/bad_level_call_stubs/stubs.c
@@ -404,7 +404,6 @@ int WM_keymap_map_type_get(struct wmKeyMapItem *kmi) RET_ZERO
/* rna editors */
-struct EditMesh;
struct FCurve *verify_fcurve(struct bAction *act, const char group[], struct PointerRNA *ptr, const char rna_path[], const int array_index, short add) RET_NULL
int insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag) RET_ZERO
More information about the Bf-blender-cvs
mailing list