Docs: doxy cleanup/minor edits

This commit is contained in:
Campbell Barton
2015-08-01 12:36:14 +10:00
parent 1c626f823d
commit 49f88326af
8 changed files with 19 additions and 19 deletions

View File

@@ -7,7 +7,7 @@
* These pages document the source code of blender. * These pages document the source code of blender.
* *
* \subsection implinks Important Links * \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. * - <a href="http://wiki.blender.org/index.php/Dev:Contents">Development documents</a> on our wiki.
* *
* \subsection blother Other * \subsection blother Other

View File

@@ -11,7 +11,6 @@
/** \defgroup bmesh BMesh /** \defgroup bmesh BMesh
* \ingroup blender * \ingroup blender
*/ */
/** \defgroup texture Texturing */
/** \defgroup compositor Compositing */ /** \defgroup compositor Compositing */
/** \defgroup python Python /** \defgroup python Python
@@ -322,7 +321,7 @@
* \ingroup gui * \ingroup gui
*/ */
/** \defgroup externformats external formats */ /** \defgroup externformats External Formats */
/** \defgroup collada COLLADA /** \defgroup collada COLLADA
* \ingroup externformats * \ingroup externformats

View File

@@ -228,7 +228,7 @@ struct DerivedMesh {
int (*getNumPolys)(DerivedMesh *dm); int (*getNumPolys)(DerivedMesh *dm);
/** Copy a single vert/edge/tessellated face from the derived mesh into /** 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 * of this function can be quite slow, iterating over all
* elements (editmesh) * elements (editmesh)
*/ */

View File

@@ -25,6 +25,10 @@
/** \file BKE_editmesh.h /** \file BKE_editmesh.h
* \ingroup bke * \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" #include "BKE_customdata.h"
@@ -37,14 +41,10 @@ struct Scene;
struct DerivedMesh; struct DerivedMesh;
struct MeshStatVis; struct MeshStatVis;
/* ok: the EDBM module is for editmode bmesh stuff. in contrast, the /**
* BMEdit module is for code shared with blenkernel that concerns * This structure is used for mesh edit-mode.
* the BMEditMesh structure.
*/
/* this structure replaces EditMesh.
* *
* 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 * it's tessellation, and various stuff that doesn't belong in the BMesh
* struct itself. * struct itself.
* *

View File

@@ -28,8 +28,7 @@
* *
* \addtogroup bmesh BMesh * \addtogroup bmesh BMesh
* *
* \brief BMesh is a non-manifold boundary representation designed to replace the current, limited EditMesh structure, * \brief BMesh is a non-manifold boundary representation designed to support advanced editing operations.
* solving many of the design limitations and maintenance issues of EditMesh.
* *
* *
* \section bm_structure The Structure * \section bm_structure The Structure
@@ -78,11 +77,11 @@
* *
* \subsection bm_edges_and_verts Edges and Vertices * \subsection bm_edges_and_verts Edges and Vertices
* *
* Edges and Vertices in BMesh are much like their counterparts in EditMesh, * Edges and Vertices in BMesh are primitive structures.
* except for some members private to the BMesh api.
* *
* \note There can be more than one edge between two vertices in bmesh, * \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. * 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 * \subsection bm_queries Queries

View File

@@ -1232,7 +1232,7 @@ static void *bmw_FaceLoopWalker_step(BMWalker *walker)
* *
* Starts at a tool-flagged edge and walks over the edge ring * Starts at a tool-flagged edge and walks over the edge ring
* Conditions for starting and stepping the edge ring have been * 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) static void bmw_EdgeringWalker_begin(BMWalker *walker, void *data)
{ {

View File

@@ -140,6 +140,7 @@ typedef struct ReebArcIterator {
int stride; int stride;
} ReebArcIterator; } ReebArcIterator;
#if 0
struct EditMesh; struct EditMesh;
struct EdgeIndex; struct EdgeIndex;
@@ -152,6 +153,8 @@ void arcToVCol(struct ReebGraph *rg, struct EditMesh *em, int index);
void renormalizeWeight(struct EditMesh *em, float newmax); void renormalizeWeight(struct EditMesh *em, float newmax);
ReebGraph *generateReebGraph(struct EditMesh *me, int subdivisions); ReebGraph *generateReebGraph(struct EditMesh *me, int subdivisions);
#endif
ReebGraph *newReebGraph(void); ReebGraph *newReebGraph(void);
void initArcIterator(BArcIterator *iter, struct ReebArc *arc, struct ReebNode *head); void initArcIterator(BArcIterator *iter, struct ReebArc *arc, struct ReebNode *head);

View File

@@ -404,7 +404,6 @@ int WM_keymap_map_type_get(struct wmKeyMapItem *kmi) RET_ZERO
/* rna editors */ /* 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 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 int insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag) RET_ZERO