From 6b2d1d1493c773c2cf3d7eb5dcd504981f0d8f31 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Sat, 22 Feb 2014 18:51:32 +1100
Subject: Docs: doxygen sections for bmesh walkers

---
 source/blender/bmesh/intern/bmesh_walkers_impl.c | 57 ++++++++++++++++++------
 1 file changed, 43 insertions(+), 14 deletions(-)

(limited to 'source/blender/bmesh/intern/bmesh_walkers_impl.c')

diff --git a/source/blender/bmesh/intern/bmesh_walkers_impl.c b/source/blender/bmesh/intern/bmesh_walkers_impl.c
index 4cf252e76e8..dee50151c61 100644
--- a/source/blender/bmesh/intern/bmesh_walkers_impl.c
+++ b/source/blender/bmesh/intern/bmesh_walkers_impl.c
@@ -42,6 +42,9 @@
 	BMW_state_remove(walker); \
 } (void)0
 
+/** \name Mask Flag Checks
+ * \{ */
+
 static bool bmw_mask_check_vert(BMWalker *walker, BMVert *v)
 {
 	if ((walker->flag & BMW_FLAG_TEST_HIDDEN) && BM_elem_flag_test(v, BM_ELEM_HIDDEN)) {
@@ -81,8 +84,11 @@ static bool bmw_mask_check_face(BMWalker *walker, BMFace *f)
 	}
 }
 
-/**
- * Shell Walker:
+/** \} */
+
+
+/** \name Shell Walker
+ * \{
  *
  * Starts at a vertex on the mesh and walks over the 'shell' it belongs
  * to via visiting connected edges.
@@ -212,8 +218,11 @@ static void *bmw_ShellWalker_step(BMWalker *walker)
 }
 #endif
 
-/**
- * Connected Vertex Walker:
+/** \} */
+
+
+/** \name Connected Vertex Walker
+ * \{
  *
  * Similar to shell walker, but visits vertices instead of edges.
  */
@@ -270,8 +279,11 @@ static void *bmw_ConnectedVertexWalker_step(BMWalker *walker)
 	return v;
 }
 
-/**
- * Island Boundary Walker:
+/** \} */
+
+
+/** \name Island Boundary Walker
+ * \{
  *
  * Starts at a edge on the mesh and walks over the boundary of an island it belongs to.
  *
@@ -367,8 +379,8 @@ static void *bmw_IslandboundWalker_step(BMWalker *walker)
 }
 
 
-/**
- * Island Walker:
+/** \name Island Walker
+ * \{
  *
  * Starts at a tool flagged-face and walks over the face region
  *
@@ -438,9 +450,11 @@ static void *bmw_IslandWalker_step(BMWalker *walker)
 	return owalk.cur;
 }
 
+/** \} */
 
-/**
- * Edge Loop Walker:
+
+/** \name Edge Loop Walker
+ * \{
  *
  * Starts at a tool-flagged edge and walks over the edge loop
  */
@@ -689,8 +703,11 @@ static void *bmw_LoopWalker_step(BMWalker *walker)
 	return owalk.cur;
 }
 
-/**
- * Face Loop Walker:
+/** \} */
+
+
+/** \name Face Loop Walker
+ * \{
  *
  * Starts at a tool-flagged face and walks over the face loop
  * Conditions for starting and stepping the face loop have been
@@ -830,10 +847,13 @@ static void *bmw_FaceLoopWalker_step(BMWalker *walker)
 	return f;
 }
 
+/** \} */
+
+
 // #define BMW_EDGERING_NGON
 
-/**
- * Edge Ring Walker:
+/** \name Edge Ring Walker
+ * \{
  *
  * Starts at a tool-flagged edge and walks over the edge ring
  * Conditions for starting and stepping the edge ring have been
@@ -970,6 +990,12 @@ static void *bmw_EdgeringWalker_step(BMWalker *walker)
 #undef EDGE_CHECK
 }
 
+/** \} */
+
+
+/** \name UV Edge Walker
+ * \{ */
+
 static void bmw_UVEdgeWalker_begin(BMWalker *walker, void *data)
 {
 	BMwUVEdgeWalker *lwalk;
@@ -1053,6 +1079,9 @@ static void *bmw_UVEdgeWalker_step(BMWalker *walker)
 	return l;
 }
 
+/** \} */
+
+
 static BMWalker bmw_ShellWalker_Type = {
 	bmw_ShellWalker_begin,
 	bmw_ShellWalker_step,
-- 
cgit v1.2.3