Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2012-08-13 19:17:15 +0400
committerCampbell Barton <ideasman42@gmail.com>2012-08-13 19:17:15 +0400
commitca7d1ec39d5ee52c5a12cb40344adfe227ea6dcf (patch)
tree682021f83357f581714397f8cd2feba8120a4555 /source/blender/bmesh
parent39945fedf32fccf4dae5f83ed08ed34aa799d919 (diff)
style cleanup: use <pre> for doxygen ascii art
Diffstat (limited to 'source/blender/bmesh')
-rw-r--r--source/blender/bmesh/intern/bmesh_construct.c4
-rw-r--r--source/blender/bmesh/intern/bmesh_core.c12
-rw-r--r--source/blender/bmesh/intern/bmesh_interp.c3
-rw-r--r--source/blender/bmesh/intern/bmesh_mods.c7
-rw-r--r--source/blender/bmesh/intern/bmesh_queries.c11
-rw-r--r--source/blender/bmesh/intern/bmesh_structure.c4
-rw-r--r--source/blender/bmesh/operators/bmo_subdivide.c38
-rw-r--r--source/blender/bmesh/tools/BME_bevel.c15
8 files changed, 59 insertions, 35 deletions
diff --git a/source/blender/bmesh/intern/bmesh_construct.c b/source/blender/bmesh/intern/bmesh_construct.c
index 589a5fbaa66..4740140187d 100644
--- a/source/blender/bmesh/intern/bmesh_construct.c
+++ b/source/blender/bmesh/intern/bmesh_construct.c
@@ -539,8 +539,8 @@ void BMO_remove_tagged_verts(BMesh *bm, const short oflag)
}
}
-/*************************************************************/
-/* you need to make remove tagged verts/edges/faces
+/**
+ * you need to make remove tagged verts/edges/faces
* api functions that take a filter callback.....
* and this new filter type will be for opstack flags.
* This is because the BM_remove_taggedXXX functions bypass iterator API.
diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c
index 8c5adb3cceb..188d35c6829 100644
--- a/source/blender/bmesh/intern/bmesh_core.c
+++ b/source/blender/bmesh/intern/bmesh_core.c
@@ -1134,7 +1134,7 @@ static BMFace *bm_face_create__sfme(BMesh *bm, BMFace *UNUSED(example))
* The second region has a new face assigned to it.
*
* \par Examples:
- *
+ * <pre>
* Before: After:
* +--------+ +--------+
* | | | |
@@ -1143,6 +1143,7 @@ static BMFace *bm_face_create__sfme(BMesh *bm, BMFace *UNUSED(example))
* | | | f2 |
* | | | |
* +--------+ +--------+
+ * </pre>
*
* \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
@@ -1302,12 +1303,13 @@ BMFace *bmesh_sfme(BMesh *bm, BMFace *f, BMVert *v1, BMVert *v2,
* will be attached to that end and is returned in \a r_e.
*
* \par Examples:
- *
+ * <pre>
* E
* Before: OV-------------TV
*
* E RE
* After: OV------NV-----TV
+ * </pre>
*
* \return The newly created BMVert pointer.
*/
@@ -1474,7 +1476,7 @@ BMVert *bmesh_semv(BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e)
* and collapses the edge on that vertex.
*
* \par Examples:
- *
+ * <pre>
* Before: OE KE
* ------- -------
* | || |
@@ -1485,6 +1487,7 @@ BMVert *bmesh_semv(BMesh *bm, BMVert *tv, BMEdge *e, BMEdge **r_e)
* ---------------
* | |
* OV TV
+ * </pre>
*
* \par Restrictions:
* KV is a vertex that must have a valance of exactly two. Furthermore
@@ -1636,7 +1639,7 @@ BMEdge *bmesh_jekv(BMesh *bm, BMEdge *ke, BMVert *kv, const short check_edge_dou
* Both faces in its radial cycle
*
* \par Examples:
- *
+ * <pre>
* A B
* +--------+ +--------+
* | | | |
@@ -1645,6 +1648,7 @@ BMEdge *bmesh_jekv(BMesh *bm, BMEdge *ke, BMVert *kv, const short check_edge_dou
* | f2 | | f2 |
* | | | |
* +--------+ +--------+
+ * </pre>
*
* In the example A, faces \a f1 and \a f2 are joined by a single edge,
* and the euler can safely be used.
diff --git a/source/blender/bmesh/intern/bmesh_interp.c b/source/blender/bmesh/intern/bmesh_interp.c
index 74d3df01fd0..9453932b684 100644
--- a/source/blender/bmesh/intern/bmesh_interp.c
+++ b/source/blender/bmesh/intern/bmesh_interp.c
@@ -186,7 +186,7 @@ void BM_face_interp_from_face(BMesh *bm, BMFace *target, BMFace *source)
* \brief Multires Interpolation
*
* mdisps is a grid of displacements, ordered thus:
- *
+ * <pre>
* v1/center----v4/next -> x
* | |
* | |
@@ -194,6 +194,7 @@ void BM_face_interp_from_face(BMesh *bm, BMFace *target, BMFace *source)
* |
* V
* y
+ * </pre>
*/
static int compute_mdisp_quad(BMLoop *l, float v1[3], float v2[3], float v3[3], float v4[3],
float e1[3], float e2[3])
diff --git a/source/blender/bmesh/intern/bmesh_mods.c b/source/blender/bmesh/intern/bmesh_mods.c
index b29970dc886..a549c700c07 100644
--- a/source/blender/bmesh/intern/bmesh_mods.c
+++ b/source/blender/bmesh/intern/bmesh_mods.c
@@ -45,20 +45,21 @@
* Turns the face region surrounding a manifold vertex into a single polygon.
*
* \par Example:
- *
+ * <pre>
* +---------+ +---------+
* | \ / | | |
* Before: | v | After: | |
* | / \ | | |
* +---------+ +---------+
- *
+ * </pre>
*
* This function can also collapse edges too
* in cases when it cant merge into faces.
*
* \par Example:
- *
+ * <pre>
* Before: +----v----+ After: +---------+
+ * </pre>
*
* \note dissolves vert, in more situations then BM_disk_dissolve
* (e.g. if the vert is part of a wire edge, etc).
diff --git a/source/blender/bmesh/intern/bmesh_queries.c b/source/blender/bmesh/intern/bmesh_queries.c
index 10ea21291db..ef5145d6582 100644
--- a/source/blender/bmesh/intern/bmesh_queries.c
+++ b/source/blender/bmesh/intern/bmesh_queries.c
@@ -54,7 +54,7 @@ int BM_vert_in_edge(BMEdge *e, BMVert *v)
* \brief Other Loop in Face Sharing an Edge
*
* Finds the other loop that shares \a v with \a e loop in \a f.
- *
+ * <pre>
* +----------+
* | |
* | f |
@@ -64,7 +64,7 @@ int BM_vert_in_edge(BMEdge *e, BMVert *v)
* ^ ^ <------- These vert args define direction
* in the face to check.
* The faces loop direction is ignored.
- *
+ * </pre>
*/
BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v)
{
@@ -92,8 +92,7 @@ BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v)
* This function returns a loop in \a f that shares an edge with \a v
* The direction is defined by \a v_prev, where the return value is
* the loop of what would be 'v_next'
- *
- *
+ * <pre>
* +----------+ <-- return the face loop of this vertex.
* | |
* | f |
@@ -103,6 +102,7 @@ BMLoop *BM_face_other_edge_loop(BMFace *f, BMEdge *e, BMVert *v)
* ^^^^^^ ^ <-- These vert args define direction
* in the face to check.
* The faces loop direction is ignored.
+ * </pre>
*
* \note \a v_prev and \a v _implicitly_ define an edge.
*/
@@ -143,7 +143,7 @@ BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v)
* \brief Other Loop in Face Sharing a Vert
*
* Finds the other loop that shares \a v with \a e loop in \a f.
- *
+ * <pre>
* +----------+ <-- return the face loop of this vertex.
* | |
* | |
@@ -153,6 +153,7 @@ BMLoop *BM_face_other_vert_loop(BMFace *f, BMVert *v_prev, BMVert *v)
* ^ <------- This loop defines both the face to search
* and the edge, in combination with 'v'
* The faces loop direction is ignored.
+ * </pre>
*/
BMLoop *BM_loop_other_vert_loop(BMLoop *l, BMVert *v)
diff --git a/source/blender/bmesh/intern/bmesh_structure.c b/source/blender/bmesh/intern/bmesh_structure.c
index 7fcd6f39fb8..2ff9e707b59 100644
--- a/source/blender/bmesh/intern/bmesh_structure.c
+++ b/source/blender/bmesh/intern/bmesh_structure.c
@@ -203,9 +203,9 @@ void bmesh_disk_edge_remove(BMEdge *e, BMVert *v)
/**
* \brief Next Disk Edge
*
- * Find the next edge in a disk cycle
+ * Find the next edge in a disk cycle
*
- * \return Pointer to the next edge in the disk cycle for the vertex v.
+ * \return Pointer to the next edge in the disk cycle for the vertex v.
*/
BMEdge *bmesh_disk_edge_next(BMEdge *e, BMVert *v)
{
diff --git a/source/blender/bmesh/operators/bmo_subdivide.c b/source/blender/bmesh/operators/bmo_subdivide.c
index a03aa0caf10..2af764060fb 100644
--- a/source/blender/bmesh/operators/bmo_subdivide.c
+++ b/source/blender/bmesh/operators/bmo_subdivide.c
@@ -269,13 +269,15 @@ static void bm_subdivide_multicut(BMesh *bm, BMEdge *edge, const SubDParams *par
* match the input geometry. they're based on the
* pre-split state of the face */
-/*
+/**
+ * <pre>
* v3---------v2
* | |
* | |
* | |
* | |
* v4---v0---v1
+ * </pre>
*/
static void quad_1edge_split(BMesh *bm, BMFace *UNUSED(face),
BMVert **verts, const SubDParams *params)
@@ -313,13 +315,15 @@ static SubDPattern quad_1edge = {
};
-/*
+/**
+ * <pre>
* v6--------v5
* | |
* | |v4s
* | |v3s
* | s s |
* v7-v0--v1-v2
+ * </pre>
*/
static void quad_2edge_split_path(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -339,13 +343,15 @@ static SubDPattern quad_2edge_path = {
4,
};
-/*
+/**
+ * <pre>
* v6--------v5
* | |
* | |v4s
* | |v3s
* | s s |
* v7-v0--v1-v2
+ * </pre>
*/
static void quad_2edge_split_innervert(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -379,14 +385,15 @@ static SubDPattern quad_2edge_innervert = {
4,
};
-/*
+/**
+ * <pre>
* v6--------v5
* | |
* | |v4s
* | |v3s
* | s s |
* v7-v0--v1-v2
- *
+ * </pre>
*/
static void quad_2edge_split_fan(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -409,7 +416,8 @@ static SubDPattern quad_2edge_fan = {
4,
};
-/*
+/**
+ * <pre>
* s s
* v8--v7--v6-v5
* | |
@@ -418,6 +426,7 @@ static SubDPattern quad_2edge_fan = {
* | v3 s
* | s s |
* v9-v0--v1-v2
+ * </pre>
*/
static void quad_3edge_split(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -446,7 +455,8 @@ static SubDPattern quad_3edge = {
4,
};
-/*
+/**
+ * <pre>
* v8--v7-v6--v5
* | s |
* |v9 s s|v4
@@ -455,6 +465,7 @@ static SubDPattern quad_3edge = {
* v11-v0--v1-v2
*
* it goes from bottom up
+ * </pre>
*/
static void quad_4edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -525,7 +536,8 @@ static void quad_4edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts
MEM_freeN(lines);
}
-/*
+/**
+ * <pre>
* v3
* / \
* / \
@@ -534,6 +546,7 @@ static void quad_4edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts
* / \
* v4--v0--v1--v2
* s s
+ * </pre>
*/
static void tri_1edge_split(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -552,7 +565,9 @@ static SubDPattern tri_1edge = {
3,
};
-/* v5
+/**
+ * <pre>
+ * v5
* / \
* s v6/---\ v4 s
* / \ / \
@@ -560,6 +575,7 @@ static SubDPattern tri_1edge = {
* / \/ \/ \
* v8--v0--v1--v2
* s s
+ * </pre>
*/
static void tri_3edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
const SubDParams *params)
@@ -610,7 +626,8 @@ static void tri_3edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
}
}
- /*
+ /**
+ * <pre>
* v5
* / \
* s v6/---\ v4 s
@@ -619,6 +636,7 @@ static void tri_3edge_subdivide(BMesh *bm, BMFace *UNUSED(face), BMVert **verts,
* / \/ \/ \
* v8--v0--v1--v2
* s s
+ * </pre>
*/
for (i = 1; i < numcuts + 1; i++) {
for (j = 0; j < i; j++) {
diff --git a/source/blender/bmesh/tools/BME_bevel.c b/source/blender/bmesh/tools/BME_bevel.c
index eb498ebf9ab..85beb6d092b 100644
--- a/source/blender/bmesh/tools/BME_bevel.c
+++ b/source/blender/bmesh/tools/BME_bevel.c
@@ -1029,17 +1029,16 @@ static BMesh *BME_bevel_reinitialize(BMesh *bm)
#endif
/**
- * BME_bevel_mesh
+ * BME_bevel_mesh
*
- * Mesh beveling tool:
+ * Mesh beveling tool:
*
- * Bevels an entire mesh. It currently uses the flags of
- * its vertices and edges to track topological changes.
- * The parameter "value" is the distance to inset (should be negative).
- * The parameter "options" is not currently used.
+ * Bevels an entire mesh. It currently uses the flags of
+ * its vertices and edges to track topological changes.
+ * The parameter "value" is the distance to inset (should be negative).
+ * The parameter "options" is not currently used.
*
- * Returns -
- * A BMesh pointer to the BM passed as a parameter.
+ * \return A BMesh pointer to the BM passed as a parameter.
*/
static BMesh *BME_bevel_mesh(BMesh *bm, float value, int UNUSED(res), int options,