[Bf-blender-cvs] [c402cfa3085] master: Cleanup: move comment into function doc-string

[Campbell Barton]

Commit: c402cfa3085188dabcb7b8576f85d482b3efae1f
Author: Campbell Barton
Date:   Fri Feb 26 16:30:06 2021 +1100
Branches: master
https://developer.blender.org/rBc402cfa3085188dabcb7b8576f85d482b3efae1f

Cleanup: move comment into function doc-string

===================================================================

M	source/blender/editors/armature/editarmature_undo.c
M	source/blender/editors/curve/editcurve_undo.c
M	source/blender/editors/lattice/editlattice_undo.c
M	source/blender/editors/mesh/editmesh_undo.c
M	source/blender/editors/metaball/editmball_undo.c
M	source/blender/editors/undo/ed_undo.c

===================================================================

diff --git a/source/blender/editors/armature/editarmature_undo.c b/source/blender/editors/armature/editarmature_undo.c
index 3768de96340..725945f8edc 100644
--- a/source/blender/editors/armature/editarmature_undo.c
+++ b/source/blender/editors/armature/editarmature_undo.c
@@ -187,7 +187,6 @@ static void armature_undosys_step_decode(struct bContext *C,
 {
   ArmatureUndoStep *us = (ArmatureUndoStep *)us_p;
 
-  /* Load all our objects  into edit-mode, clear everything else. */
   ED_undo_object_editmode_restore_helper(
       C, &us->elems[0].obedit_ref.ptr, us->elems_len, sizeof(*us->elems));
 
diff --git a/source/blender/editors/curve/editcurve_undo.c b/source/blender/editors/curve/editcurve_undo.c
index 48666821732..b07c3c85f4a 100644
--- a/source/blender/editors/curve/editcurve_undo.c
+++ b/source/blender/editors/curve/editcurve_undo.c
@@ -248,7 +248,6 @@ static void curve_undosys_step_decode(struct bContext *C,
 {
   CurveUndoStep *us = (CurveUndoStep *)us_p;
 
-  /* Load all our objects  into edit-mode, clear everything else. */
   ED_undo_object_editmode_restore_helper(
       C, &us->elems[0].obedit_ref.ptr, us->elems_len, sizeof(*us->elems));
 
diff --git a/source/blender/editors/lattice/editlattice_undo.c b/source/blender/editors/lattice/editlattice_undo.c
index 2a6edc3249f..d92a81179cc 100644
--- a/source/blender/editors/lattice/editlattice_undo.c
+++ b/source/blender/editors/lattice/editlattice_undo.c
@@ -221,7 +221,6 @@ static void lattice_undosys_step_decode(struct bContext *C,
 {
   LatticeUndoStep *us = (LatticeUndoStep *)us_p;
 
-  /* Load all our objects  into edit-mode, clear everything else. */
   ED_undo_object_editmode_restore_helper(
       C, &us->elems[0].obedit_ref.ptr, us->elems_len, sizeof(*us->elems));
 
diff --git a/source/blender/editors/mesh/editmesh_undo.c b/source/blender/editors/mesh/editmesh_undo.c
index 67816f069f6..79385e28aa9 100644
--- a/source/blender/editors/mesh/editmesh_undo.c
+++ b/source/blender/editors/mesh/editmesh_undo.c
@@ -775,7 +775,6 @@ static void mesh_undosys_step_decode(struct bContext *C,
 {
   MeshUndoStep *us = (MeshUndoStep *)us_p;
 
-  /* Load all our objects  into edit-mode, clear everything else. */
   ED_undo_object_editmode_restore_helper(
       C, &us->elems[0].obedit_ref.ptr, us->elems_len, sizeof(*us->elems));
 
diff --git a/source/blender/editors/metaball/editmball_undo.c b/source/blender/editors/metaball/editmball_undo.c
index 457c5330595..a8b471a7c92 100644
--- a/source/blender/editors/metaball/editmball_undo.c
+++ b/source/blender/editors/metaball/editmball_undo.c
@@ -196,7 +196,6 @@ static void mball_undosys_step_decode(struct bContext *C,
 {
   MBallUndoStep *us = (MBallUndoStep *)us_p;
 
-  /* Load all our objects  into edit-mode, clear everything else. */
   ED_undo_object_editmode_restore_helper(
       C, &us->elems[0].obedit_ref.ptr, us->elems_len, sizeof(*us->elems));
 
diff --git a/source/blender/editors/undo/ed_undo.c b/source/blender/editors/undo/ed_undo.c
index 2e5d233f207..7d8f72f3779 100644
--- a/source/blender/editors/undo/ed_undo.c
+++ b/source/blender/editors/undo/ed_undo.c
@@ -863,6 +863,9 @@ void ED_undo_object_set_active_or_warn(
   }
 }
 
+/**
+ * Load all our objects from `object_array` into edit-mode, clear everything else.
+ */
 void ED_undo_object_editmode_restore_helper(struct bContext *C,
                                             Object **object_array,
                                             uint object_array_len,