[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [44542] trunk/blender/source/blender/bmesh /intern: update doxygen comments for bmesh.
Campbell Barton
ideasman42 at gmail.com
Wed Feb 29 07:55:20 CET 2012
Revision: 44542
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=44542
Author: campbellbarton
Date: 2012-02-29 06:55:10 +0000 (Wed, 29 Feb 2012)
Log Message:
-----------
update doxygen comments for bmesh.
Modified Paths:
--------------
trunk/blender/source/blender/bmesh/intern/bmesh_construct.c
trunk/blender/source/blender/bmesh/intern/bmesh_core.c
trunk/blender/source/blender/bmesh/intern/bmesh_interp.c
trunk/blender/source/blender/bmesh/intern/bmesh_iterators.c
trunk/blender/source/blender/bmesh/intern/bmesh_iterators.h
trunk/blender/source/blender/bmesh/intern/bmesh_iterators_inline.c
trunk/blender/source/blender/bmesh/intern/bmesh_marking.c
trunk/blender/source/blender/bmesh/intern/bmesh_mesh.c
trunk/blender/source/blender/bmesh/intern/bmesh_mods.c
trunk/blender/source/blender/bmesh/intern/bmesh_operators.c
trunk/blender/source/blender/bmesh/intern/bmesh_polygon.c
trunk/blender/source/blender/bmesh/intern/bmesh_queries.c
trunk/blender/source/blender/bmesh/intern/bmesh_structure.c
trunk/blender/source/blender/bmesh/intern/bmesh_walkers.c
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_construct.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_construct.c 2012-02-29 04:17:26 UTC (rev 44541)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_construct.c 2012-02-29 06:55:10 UTC (rev 44542)
@@ -49,20 +49,18 @@
static void bm_loop_attrs_copy(BMesh *source_mesh, BMesh *target_mesh,
const BMLoop *source_loop, BMLoop *target_loop);
-/*
- * BMESH MAKE QUADTRIANGLE
+/**
+ * \brief Make Quad/Triangle
*
- * Creates a new quad or triangle from
- * a list of 3 or 4 vertices. If nodouble
- * equals 1, then a check is done to see
- * if a face with these vertices already
- * exists and returns it instead. If a pointer
- * to an example face is provided, it's custom
- * data and properties will be copied to the new
- * face.
+ * Creates a new quad or triangle from a list of 3 or 4 vertices.
+ * If \a nodouble is TRUE, then a check is done to see if a face
+ * with these vertices already exists and returns it instead.
*
- * Note that the winding of the face is determined
- * by the order of the vertices in the vertex array
+ * If a pointer to an example face is provided, it's custom data
+ * and properties will be copied to the new face.
+ *
+ * \note The winding of the face is determined by the order
+ * of the vertices in the vertex array.
*/
BMFace *BM_face_create_quad_tri(BMesh *bm,
@@ -128,17 +126,18 @@
}
/**
- * \brief BMESH MAKE NGON
+ * \brief Make NGon
*
- * Makes an ngon from an unordered list of edges. v1 and v2 must be the verts
- * defining edges[0], and define the winding of the new face.
+ * Makes an ngon from an unordered list of edges. \a v1 and \a v2
+ * must be the verts defining edges[0],
+ * and define the winding of the new face.
*
- * The edges are not required to be ordered, simply to to form
- * a single closed loop as a whole
+ * \a edges are not required to be ordered, simply to to form
+ * a single closed loop as a whole.
*
- * Note that while this function will work fine when the edges
+ * \note While this function will work fine when the edges
* are already sorted, if the edges are always going to be sorted,
- * BM_face_create should be considered over this function as it
+ * #BM_face_create should be considered over this function as it
* avoids some unnecessary work.
*/
BMFace *BM_face_create_ngon(BMesh *bm, BMVert *v1, BMVert *v2, BMEdge **edges, int len, int nodouble)
@@ -268,14 +267,10 @@
/* bmesh_make_face_from_face(BMesh *bm, BMFace *source, BMFace *target) */
-/*
- * REMOVE TAGGED XXX
- *
+/**
* Called by operators to remove elements that they have marked for
* removal.
- *
*/
-
void BMO_remove_tagged_faces(BMesh *bm, const short oflag)
{
BMFace *f;
Modified: trunk/blender/source/blender/bmesh/intern/bmesh_core.c
===================================================================
--- trunk/blender/source/blender/bmesh/intern/bmesh_core.c 2012-02-29 04:17:26 UTC (rev 44541)
+++ trunk/blender/source/blender/bmesh/intern/bmesh_core.c 2012-02-29 06:55:10 UTC (rev 44542)
@@ -20,7 +20,7 @@
* ***** END GPL LICENSE BLOCK *****
*/
-/** \file blender/bmesh/intern/bmesh_newcore.c
+/** \file blender/bmesh/intern/bmesh_core.c
* \ingroup bmesh
*
*/
@@ -445,7 +445,8 @@
return err;
}
-/* low level function, only free's,
+/**
+ * low level function, only free's,
* does not change adjust surrounding geometry */
static void bm_kill_only_vert(BMesh *bm, BMVert *v)
{
@@ -632,21 +633,6 @@
/********** private disk and radial cycle functions ********** */
-/**
- * bmesh_loop_reverse
- *
- * FLIP FACE EULER
- *
- * Changes the winding order of a face from CW to CCW or vice versa.
- * This euler is a bit peculiar in compairson to others as it is its
- * own inverse.
- *
- * BMESH_TODO: reinsert validation code.
- *
- * Returns -
- * 1 for success, 0 for failure.
- */
-
static int bm_loop_length(BMLoop *l)
{
BMLoop *l_first = l;
@@ -659,6 +645,17 @@
return i;
}
+/**
+ * \brief Loop Reverse
+ *
+ * Changes the winding order of a face from CW to CCW or vice versa.
+ * This euler is a bit peculiar in compairson to others as it is its
+ * own inverse.
+ *
+ * BMESH_TODO: reinsert validation code.
+ *
+ * \return Success
+ */
static int bm_loop_reverse_loop(BMesh *bm, BMFace *f
#ifdef USE_BMESH_HOLES
, BMLoopList *lst
@@ -856,16 +853,18 @@
/* Midlevel Topology Manipulation Functions */
/**
+ * \brief Join Connected Faces
+ *
* Joins a collected group of faces into one. Only restriction on
* the input data is that the faces must be connected to each other.
*
- * If a pair of faces share multiple edges, the pair of
- * faces will be joined at every edge.
+ * \return The newly created combine BMFace.
*
- * Returns a pointer to the combined face.
+ * \note If a pair of faces share multiple edges,
+ * the pair of faces will be joined at every edge.
*
- * \note this is a generic, flexible join faces function, almost everything
- * uses this, including #BM_faces_join_pair
+ * \note this is a generic, flexible join faces function,
+ * almost everything uses this, including #BM_faces_join_pair
*/
BMFace *BM_faces_join(BMesh *bm, BMFace **faces, int totface)
{
@@ -1045,8 +1044,6 @@
return NULL;
}
-/* BMESH_TODO - this is only used once, investigate sharing code with BM_face_create
- */
static BMFace *bm_face_create__sfme(BMesh *bm, BMFace *UNUSED(example))
{
BMFace *f;
@@ -1069,41 +1066,38 @@
}
/**
- * bmesh_SFME
+ * \brief Split Face Make Edge (SFME)
*
- * SPLIT FACE MAKE EDGE:
+ * Takes as input two vertices in a single face. An edge is created which divides the original face
+ * into two distinct regions. One of the regions is assigned to the original face and it is closed off.
+ * The second region has a new face assigned to it.
*
- * Takes as input two vertices in a single face. An edge is created which divides the original face
- * into two distinct regions. One of the regions is assigned to the original face and it is closed off.
- * The second region has a new face assigned to it.
+ * \par Examples:
*
- * Examples:
- *
* Before: After:
- * ---------- ----------
- * | | | |
- * | | | f1 |
- * v1 f1 v2 v1======v2
- * | | | f2 |
- * | | | |
- * ---------- ----------
+ * ---------- ----------
+ * | | | |
+ * | | | f1 |
+ * v1 f1 v2 v1======v2
+ * | | | f2 |
+ * | | | |
+ * ---------- ----------
*
- * Note that the input vertices can be part of the same edge. This will
- * result in a two edged face. This is desirable for advanced construction
- * tools and particularly essential for edge bevel. Because of this it is
- * up to the caller to decide what to do with the extra edge.
+ * \note the input vertices can be part of the same edge. This will
+ * result in a two edged face. This is desirable for advanced construction
+ * tools and particularly essential for edge bevel. Because of this it is
+ * up to the caller to decide what to do with the extra edge.
*
- * If holes is NULL, then both faces will lose
- * all holes from the original face. Also, you cannot split between
- * a hole vert and a boundary vert; that case is handled by higher-
- * level wrapping functions (when holes are fully implemented, anyway).
+ * \note If \a holes is NULL, then both faces will lose
+ * all holes from the original face. Also, you cannot split between
+ * a hole vert and a boundary vert; that case is handled by higher-
+ * level wrapping functions (when holes are fully implemented, anyway).
*
- * Note that holes represents which holes goes to the new face, and of
- * course this requires removing them from the exitsing face first, since
- * you cannot have linked list links inside multiple lists.
+ * \note that holes represents which holes goes to the new face, and of
+ * course this requires removing them from the exitsing face first, since
+ * you cannot have linked list links inside multiple lists.
*
- * Returns -
- * A BMFace pointer
+ * \return A BMFace pointer
*/
BMFace *bmesh_sfme(BMesh *bm, BMFace *f, BMVert *v1, BMVert *v2,
BMLoop **r_l,
@@ -1211,20 +1205,17 @@
}
/**
- * bmesh_SEMV
+ * \brief Split Edge Make Vert (SEMV)
*
- * SPLIT EDGE MAKE VERT:
- * Takes a given edge and splits it into two, creating a new vert.
+ * Takes \a e edge and splits it into two, creating a new vert.
*
+ * \par Examples:
*
- * Before: OV---------TV
- * After: OV----NV---TV
+ * Before: OV---------TV
+ * After: OV----NV---TV
*
- * Returns -
- * BMVert pointer.
- *
+ * \return The newly created BMVert pointer.
*/
-
BMVert *bmesh_semv(BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e)
{
BMLoop *nextl;
@@ -1385,35 +1376,33 @@
}
/**
- * bmesh_JEKV
+ * \brief Join Edge Kill Vert (JEKV)
*
- * JOIN EDGE KILL VERT:
- * Takes a an edge and pointer to one of its vertices and collapses
- * the edge on that vertex.
+ * Takes an edge \a ke and pointer to one of its vertices \a kv
+ * and collapses the edge on that vertex.
*
- * Before: OE KE
- * ------- -------
- * | || |
- * OV KV TV
+ * \par Examples:
*
+ * Before: OE KE
+ * ------- -------
+ * | || |
+ * OV KV TV
*
- * After: OE
- * ---------------
- * | |
- * OV TV
*
+ * After: OE
+ * ---------------
+ * | |
+ * OV TV
*
- * Restrictions:
- * KV is a vertex that must have a valance of exactly two. Furthermore
- * both edges in KV's disk cycle (OE and KE) must be unique (no double
- * edges).
+ * \par Restrictions:
+ * KV is a vertex that must have a valance of exactly two. Furthermore
+ * both edges in KV's disk cycle (OE and KE) must be unique (no double edges).
*
- * It should also be noted that this euler has the possibility of creating
- * faces with just 2 edges. It is up to the caller to decide what to do with
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list