[Bf-blender-cvs] [e9dd060] master: Doc: remove todo's from BMesh code

[Campbell Barton]

Commit: e9dd060102f2ca84530ed000a063abbd53b99962
Author: Campbell Barton
Date:   Fri Sep 18 07:39:56 2015 +1000
Branches: master
https://developer.blender.org/rBe9dd060102f2ca84530ed000a063abbd53b99962

Doc: remove todo's from BMesh code

These were out of date and better have outside the source.

Also clarify BMLoop description.

===================================================================

M	source/blender/bmesh/bmesh.h

===================================================================

diff --git a/source/blender/bmesh/bmesh.h b/source/blender/bmesh/bmesh.h
index 0595a86..78c814a 100644
--- a/source/blender/bmesh/bmesh.h
+++ b/source/blender/bmesh/bmesh.h
@@ -57,10 +57,14 @@
  *
  * \subsection bm_loop The Loop
  *
+ * Loops can be thought of as a *face-corner*, since faces don't reference verts or edges directly.
  * Each loop connects the face to one of its corner vertices,
  * and also references an edge which connects this loop's vertex to the next loop's vertex.
  *
- * Loops store several handy pointers:
+ * Loops allow faces to access their verts and edges,
+ * while edges and faces store their loops, allowing access in the opposite direction too.
+ *
+ * Loop pointers:
  *
  * - BMLoop#v - pointer to the vertex associated with this loop.
  * - BMLoop#e - pointer to the edge associated with this loop,
@@ -199,18 +203,6 @@
  *
  * There may be a better place for this section, but adding here for now.
  *
- * \subsection bm_todo_tools Tools
- *
- * Probably most of these will be bmesh operators.
- *
- * - make ngons flat.
- * - solidify (precise mode), keeps even wall thickness, re-creates outlines of offset faces with plane-plane
- *   intersections.
- * - split vert (we already have in our API, just no tool).
- * - flip selected region (invert all faces about the plane defined by the selected region outline)
- * - interactive dissolve (like the knife tool but draw over edges to dissolve)
- *
- *
  * \subsection bm_todo_optimize Optimizations
  *
  * - skip normal calc when its not needed (when calling chain of operators & for modifiers, flag as dirty)
@@ -218,11 +210,6 @@
  * - ability to call BMO's with option not to create return data (will save some time)
  * - binary diff UNDO, currently this uses huge amount of ram when all shapes are stored for each undo step for eg.
  * - use two different iterator types for BMO map/buffer types.
- *
- *
- * \subsection bm_todo_tools_enhance Tool Enhancements
- *
- * - vert slide UV correction (like we have for edge slide)
  */
 
 #ifdef __cplusplus