Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX

Also use doxy style function reference `#` prefix chars when
referencing identifiers.

13 files changed, 27 insertions, 27 deletions

diff --git a/source/blender/bmesh/intern/bmesh_delete.c b/source/blender/bmesh/intern/bmesh_delete.c
index f470361e5fb..9f2fb1370bb 100644
--- a/source/blender/bmesh/intern/bmesh_delete.c
+++ b/source/blender/bmesh/intern/bmesh_delete.c
@@ -205,7 +205,7 @@ void BMO_mesh_delete_oflag_context(BMesh *bm, const short oflag, const int type)
 
 /* BM functions
  *
- * note! this is just a duplicate of the code above (bad!)
+ * NOTE: this is just a duplicate of the code above (bad!)
  * but for now keep in sync, its less hassle than having to create bmesh operator flags,
  * each time we need to remove some geometry.
  */
diff --git a/source/blender/bmesh/intern/bmesh_iterators.h b/source/blender/bmesh/intern/bmesh_iterators.h
index 470aceeb756..4bb83492548 100644
--- a/source/blender/bmesh/intern/bmesh_iterators.h
+++ b/source/blender/bmesh/intern/bmesh_iterators.h
@@ -158,7 +158,7 @@ typedef void (*BMIter__begin_cb)(void *);
 typedef void *(*BMIter__step_cb)(void *);
 
 /* Iterator Structure */
-/* note: some of these vars are not used,
+/* NOTE: some of these vars are not used,
  * so they have been commented to save stack space since this struct is used all over */
 typedef struct BMIter {
   /* keep union first */
@@ -180,7 +180,7 @@ typedef struct BMIter {
   BMIter__begin_cb begin;
   BMIter__step_cb step;
 
-  int count; /* note, only some iterators set this, don't rely on it */
+  int count; /* NOTE: only some iterators set this, don't rely on it. */
   char itype;
 } BMIter;
 
diff --git a/source/blender/bmesh/intern/bmesh_log.c b/source/blender/bmesh/intern/bmesh_log.c
index 40eed6238ca..1febae54b39 100644
--- a/source/blender/bmesh/intern/bmesh_log.c
+++ b/source/blender/bmesh/intern/bmesh_log.c
@@ -397,7 +397,7 @@ static BMLogEntry *bm_log_entry_create(void)
 
 /* Free the data in a log entry
  *
- * Note: does not free the log entry itself */
+ * NOTE: does not free the log entry itself. */
 static void bm_log_entry_free(BMLogEntry *entry)
 {
   BLI_ghash_free(entry->deleted_verts, NULL, NULL);
diff --git a/source/blender/bmesh/intern/bmesh_marking.c b/source/blender/bmesh/intern/bmesh_marking.c
index 190698f504c..b70e26f51ea 100644
--- a/source/blender/bmesh/intern/bmesh_marking.c
+++ b/source/blender/bmesh/intern/bmesh_marking.c
@@ -1386,7 +1386,7 @@ void BM_mesh_elem_hflag_enable_test(BMesh *bm,
 
   BLI_assert((htype & ~BM_ALL_NOLOOP) == 0);
 
-  /* note, better not attempt a fast path for selection as done with de-select
+  /* NOTE: better not attempt a fast path for selection as done with de-select
    * because hidden geometry and different selection modes can give different results,
    * we could of course check for no hidden faces and then use
    * quicker method but its not worth it. */
diff --git a/source/blender/bmesh/intern/bmesh_mesh_normals.c b/source/blender/bmesh/intern/bmesh_mesh_normals.c
index 6ab7b8a2057..f429e77c656 100644
--- a/source/blender/bmesh/intern/bmesh_mesh_normals.c
+++ b/source/blender/bmesh/intern/bmesh_mesh_normals.c
@@ -604,7 +604,7 @@ static void bm_mesh_loops_calc_normals(BMesh *bm,
        * If we find a new, never-processed cyclic smooth fan, we can do it now using that loop/edge
        * as 'entry point', otherwise we can skip it. */
 
-      /* Note: In theory, we could make bm_mesh_loop_check_cyclic_smooth_fan() store
+      /* NOTE: In theory, we could make bm_mesh_loop_check_cyclic_smooth_fan() store
        * mlfan_pivot's in a stack, to avoid having to fan again around
        * the vert during actual computation of clnor & clnorspace. However, this would complicate
        * the code, add more memory usage, and
@@ -1281,7 +1281,7 @@ void BM_lnorspace_invalidate(BMesh *bm, const bool do_invalidate_all)
   BMVert *v;
   BMLoop *l;
   BMIter viter, liter;
-  /* Note: we could use temp tag of BMItem for that,
+  /* NOTE: we could use temp tag of BMItem for that,
    * but probably better not use it in such a low-level func?
    * --mont29 */
   BLI_bitmap *done_verts = BLI_BITMAP_NEW(bm->totvert, __func__);
diff --git a/source/blender/bmesh/intern/bmesh_mods.c b/source/blender/bmesh/intern/bmesh_mods.c
index f75497f2f19..5fa12397a07 100644
--- a/source/blender/bmesh/intern/bmesh_mods.c
+++ b/source/blender/bmesh/intern/bmesh_mods.c
@@ -183,7 +183,7 @@ bool BM_disk_dissolve(BMesh *bm, BMVert *v)
     }
 
     /* collapse the vertex */
-    /* note, the baseedge can be a boundary of manifold, use this as join_faces arg */
+    /* NOTE: the baseedge can be a boundary of manifold, use this as join_faces arg. */
     e = BM_vert_collapse_faces(
         bm, baseedge, v, 1.0, true, !BM_edge_is_boundary(baseedge), true, true);
 
@@ -873,7 +873,7 @@ bool BM_edge_rotate_check(BMEdge *e)
  */
 bool BM_edge_rotate_check_degenerate(BMEdge *e, BMLoop *l1, BMLoop *l2)
 {
-  /* note: for these vars 'old' just means initial edge state. */
+  /* NOTE: for these vars 'old' just means initial edge state. */
 
   float ed_dir_old[3];      /* edge vector */
   float ed_dir_new[3];      /* edge vector */
@@ -1054,7 +1054,7 @@ BMEdge *BM_edge_rotate(BMesh *bm, BMEdge *e, const bool ccw, const short check_f
     return NULL;
   }
 
-  /* note, this assumes joining the faces _didnt_ also remove the verts.
+  /* NOTE: this assumes joining the faces _didnt_ also remove the verts.
    * the #BM_edge_rotate_check will ensure this, but its possibly corrupt state or future edits
    * break this */
   if ((l1 = BM_face_vert_share_loop(f, v1)) && (l2 = BM_face_vert_share_loop(f, v2)) &&
diff --git a/source/blender/bmesh/intern/bmesh_opdefines.c b/source/blender/bmesh/intern/bmesh_opdefines.c
index a5cce41eee4..9466be4a300 100644
--- a/source/blender/bmesh/intern/bmesh_opdefines.c
+++ b/source/blender/bmesh/intern/bmesh_opdefines.c
@@ -567,7 +567,7 @@ static BMOpDefine bmo_contextual_create_def = {
   },
   /* slots_out */
   {{"faces.out", BMO_OP_SLOT_ELEMENT_BUF, {BM_FACE}}, /* newly-made face(s) */
-  /* note, this is for stand-alone edges only, not edges which are a part of newly created faces */
+  /* NOTE: this is for stand-alone edges only, not edges which are a part of newly created faces. */
    {"edges.out", BMO_OP_SLOT_ELEMENT_BUF, {BM_EDGE}}, /* newly-made edge(s) */
    {{'\0'}},
   },
diff --git a/source/blender/bmesh/intern/bmesh_operator_api.h b/source/blender/bmesh/intern/bmesh_operator_api.h
index d09c0ee428d..767c455e5e9 100644
--- a/source/blender/bmesh/intern/bmesh_operator_api.h
+++ b/source/blender/bmesh/intern/bmesh_operator_api.h
@@ -537,7 +537,7 @@ void BMO_slot_buffer_hflag_disable(BMesh *bm,
                                    const bool do_flush);
 
 /* puts every element of type 'type' (which is a bitmask) with header
- * flag 'flag', into a slot.  note: ignores hidden elements
+ * flag 'flag', into a slot.  NOTE: ignores hidden elements
  * (e.g. elements with header flag BM_ELEM_HIDDEN set). */
 void BMO_slot_buffer_from_enabled_hflag(BMesh *bm,
                                         BMOperator *op,
@@ -547,7 +547,7 @@ void BMO_slot_buffer_from_enabled_hflag(BMesh *bm,
                                         const char hflag);
 
 /* puts every element of type 'type' (which is a bitmask) without
- * header flag 'flag', into a slot.  note: ignores hidden elements
+ * header flag 'flag', into a slot.  NOTE: ignores hidden elements
  * (e.g. elements with header flag BM_ELEM_HIDDEN set). */
 void BMO_slot_buffer_from_disabled_hflag(BMesh *bm,
                                          BMOperator *op,
diff --git a/source/blender/bmesh/intern/bmesh_operators.c b/source/blender/bmesh/intern/bmesh_operators.c
index 303b5336a5c..37b1c9386e5 100644
--- a/source/blender/bmesh/intern/bmesh_operators.c
+++ b/source/blender/bmesh/intern/bmesh_operators.c
@@ -829,7 +829,7 @@ void BMO_slot_buffer_from_all(BMesh *bm,
 
     BMO_slot_buffer_alloc(op, slot_args, slot_name, totelement);
 
-    /* TODO - collapse these loops into one */
+    /* TODO: collapse these loops into one. */
 
     if (htype & BM_VERT) {
       BM_ITER_MESH (ele, &iter, bm, BM_VERTS_OF_MESH) {
@@ -890,7 +890,7 @@ static void bmo_slot_buffer_from_hflag(BMesh *bm,
 
     BMO_slot_buffer_alloc(op, slot_args, slot_name, totelement);
 
-    /* TODO - collapse these loops into one */
+    /* TODO: collapse these loops into one. */
 
     if (htype & BM_VERT) {
       BM_ITER_MESH (ele, &iter, bm, BM_VERTS_OF_MESH) {
@@ -1061,7 +1061,7 @@ static void bmo_slot_buffer_from_flag(BMesh *bm,
 
     ele_array = (BMHeader **)slot->data.buf;
 
-    /* TODO - collapse these loops into one */
+    /* TODO: collapse these loops into one. */
 
     if (htype & BM_VERT) {
       BM_ITER_MESH (ele, &iter, bm, BM_VERTS_OF_MESH) {
@@ -1953,7 +1953,7 @@ bool BMO_op_vinitf(BMesh *bm, BMOperator *op, const int flag, const char *_fmt,
   return true;
 error:
 
-  /* non urgent todo - explain exactly what is failing */
+  /* TODO: explain exactly what is failing (not urgent). */
   fprintf(stderr, "%s: error parsing formatting string\n", __func__);
 
   fprintf(stderr, "string: '%s', position %d\n", _fmt, (int)(fmt - ofmt));
diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c
index 5397098a7f3..0aab10e7b1a 100644
--- a/source/blender/bmesh/intern/bmesh_polygon.c
+++ b/source/blender/bmesh/intern/bmesh_polygon.c
@@ -1296,7 +1296,7 @@ void BM_face_triangulate(BMesh *bm,
               r_edges_new[ne_i++] = e;
             }
           }
-          /* note, never disable tag's */
+          /* NOTE: never disable tag's. */
         } while ((l_iter = l_iter->next) != l_first);
       }
 
diff --git a/source/blender/bmesh/intern/bmesh_polygon_edgenet.c b/source/blender/bmesh/intern/bmesh_polygon_edgenet.c
index 0754564fa47..99e50b35d97 100644
--- a/source/blender/bmesh/intern/bmesh_polygon_edgenet.c
+++ b/source/blender/bmesh/intern/bmesh_polygon_edgenet.c
@@ -49,7 +49,7 @@
  *
  * \{ */
 
-/* Note: All these flags _must_ be cleared on exit */
+/* NOTE: All these flags _must_ be cleared on exit. */
 
 /* face is a part of the edge-net (including the original face we're splitting) */
 #define FACE_NET _FLAG_WALK
@@ -519,7 +519,7 @@ bool BM_face_split_edgenet(BMesh *bm,
   } while ((l_iter = l_iter->next) != l_first);
 #endif
 
-  /* Note: 'VERT_IN_QUEUE' is often not needed at all,
+  /* NOTE: 'VERT_IN_QUEUE' is often not needed at all,
    * however in rare cases verts are added multiple times to the queue,
    * that on its own is harmless but in _very_ rare cases,
    * the queue will overflow its maximum size,
@@ -1299,7 +1299,7 @@ bool BM_face_split_edgenet_connect_islands(BMesh *bm,
         BMVert *v_delimit = (&edge_arr[i]->v1)[j];
         BMVert *v_other;
 
-        /* note, remapping will _never_ map a vertex to an already mapped vertex */
+        /* NOTE: remapping will _never_ map a vertex to an already mapped vertex. */
         while (UNLIKELY((v_other = bm_face_split_edgenet_partial_connect(bm, v_delimit, f)))) {
           struct TempVertPair *tvp = BLI_memarena_alloc(mem_arena, sizeof(*tvp));
           tvp->next = temp_vert_pairs.list;
diff --git a/source/blender/bmesh/intern/bmesh_query.c b/source/blender/bmesh/intern/bmesh_query.c
index 8047b52b625..bc881040e4e 100644
--- a/source/blender/bmesh/intern/bmesh_query.c
+++ b/source/blender/bmesh/intern/bmesh_query.c
@@ -1544,12 +1544,12 @@ float BM_loop_calc_face_angle(const BMLoop *l)
  */
 float BM_loop_calc_face_normal_safe_ex(const BMLoop *l, const float epsilon_sq, float r_normal[3])
 {
-  /* Note: we cannot use result of normal_tri_v3 here to detect colinear vectors
+  /* NOTE: we cannot use result of normal_tri_v3 here to detect colinear vectors
    * (vertex on a straight line) from zero value,
    * because it does not normalize both vectors before making cross-product.
    * Instead of adding two costly normalize computations,
    * just check ourselves for colinear case. */
-  /* Note: FEPSILON might need some finer tweaking at some point?
+  /* NOTE: FEPSILON might need some finer tweaking at some point?
    * Seems to be working OK for now though. */
   float v1[3], v2[3], v_tmp[3];
   sub_v3_v3v3(v1, l->prev->v->co, l->v->co);
@@ -1807,7 +1807,7 @@ void BM_edge_calc_face_tangent(const BMEdge *e, const BMLoop *e_loop, float r_ta
   BM_edge_ordered_verts_ex(e, &v1, &v2, e_loop);
 
   sub_v3_v3v3(tvec, v1->co, v2->co); /* use for temp storage */
-  /* note, we could average the tangents of both loops,
+  /* NOTE: we could average the tangents of both loops,
    * for non flat ngons it will give a better direction */
   cross_v3_v3v3(r_tangent, tvec, e_loop->f->no);
   normalize_v3(r_tangent);
@@ -2591,7 +2591,7 @@ double BM_mesh_calc_volume(BMesh *bm, bool is_signed)
   return vol;
 }
 
-/* note, almost duplicate of BM_mesh_calc_edge_groups, keep in sync */
+/* NOTE: almost duplicate of #BM_mesh_calc_edge_groups, keep in sync. */
 /**
  * Calculate isolated groups of faces with optional filtering.
  *
@@ -2753,7 +2753,7 @@ int BM_mesh_calc_face_groups(BMesh *bm,
   return group_curr;
 }
 
-/* note, almost duplicate of BM_mesh_calc_face_groups, keep in sync */
+/* NOTE: almost duplicate of #BM_mesh_calc_face_groups, keep in sync. */
 /**
  * Calculate isolated groups of edges with optional filtering.
  *
diff --git a/source/blender/bmesh/intern/bmesh_structure.h b/source/blender/bmesh/intern/bmesh_structure.h
index b3b9536618c..ca51a9c39de 100644
--- a/source/blender/bmesh/intern/bmesh_structure.h
+++ b/source/blender/bmesh/intern/bmesh_structure.h
@@ -63,7 +63,7 @@ BMEdge *bmesh_disk_faceedge_find_next(const BMEdge *e, const BMVert *v) ATTR_WAR
 void bmesh_radial_loop_append(BMEdge *e, BMLoop *l) ATTR_NONNULL();
 void bmesh_radial_loop_remove(BMEdge *e, BMLoop *l) ATTR_NONNULL();
 void bmesh_radial_loop_unlink(BMLoop *l) ATTR_NONNULL();
-/* note:
+/* NOTE:
  *      bmesh_radial_loop_next(BMLoop *l) / prev.
  * just use member access l->radial_next, l->radial_prev now */