[Bf-blender-cvs] [c4d56199ccd] master: Cleanup: use doxy sections for editcurve_select.c

[Campbell Barton]

Commit: c4d56199ccde00601159ac43d252ff87a4272ea1
Author: Campbell Barton
Date:   Mon Jun 28 20:16:26 2021 +1000
Branches: master
https://developer.blender.org/rBc4d56199ccde00601159ac43d252ff87a4272ea1

Cleanup: use doxy sections for editcurve_select.c

Signed-off-by: Campbell Barton <ideasman42 at gmail.com>

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

M	source/blender/editors/curve/editcurve_select.c

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

diff --git a/source/blender/editors/curve/editcurve_select.c b/source/blender/editors/curve/editcurve_select.c
index 35e102d60de..a265a794f56 100644
--- a/source/blender/editors/curve/editcurve_select.c
+++ b/source/blender/editors/curve/editcurve_select.c
@@ -56,6 +56,10 @@
 
 #include "DEG_depsgraph.h"
 
+/* -------------------------------------------------------------------- */
+/** \name Utilities
+ * \{ */
+
 /* returns 1 in case (de)selection was successful */
 bool select_beztriple(BezTriple *bezt, bool selstatus, uint8_t flag, eVisible_Types hidden)
 {
@@ -398,12 +402,18 @@ static void select_adjacent_cp(ListBase *editnurb,
   }
 }
 
-/**************** select start/end operators **************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Start/End Operators
+ * \{ */
 
-/* (de)selects first or last of visible part of each Nurb depending on selFirst
- * selFirst: defines the end of which to select
- * doswap: defines if selection state of each first/last control point is swapped
- * selstatus: selection status in case doswap is false
+/**
+ * (De)selects first or last of visible part of each #Nurb depending on `selfirst`.
+ *
+ * \param selfirst: defines the end of which to select.
+ * \param doswap: defines if selection state of each first/last control point is swapped.
+ * \param selstatus: selection status in case `doswap` is false.
  */
 static void selectend_nurb(Object *obedit, eEndPoint_Types selfirst, bool doswap, bool selstatus)
 {
@@ -543,6 +553,12 @@ void CURVE_OT_de_select_last(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select All Operator
+ * \{ */
+
 static int de_select_all_exec(bContext *C, wmOperator *op)
 {
   int action = RNA_enum_get(op->ptr, "action");
@@ -612,7 +628,11 @@ void CURVE_OT_select_all(wmOperatorType *ot)
   WM_operator_properties_select_all(ot);
 }
 
-/***************** select linked operator ******************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Linked Operator
+ * \{ */
 
 static int select_linked_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -668,7 +688,11 @@ void CURVE_OT_select_linked(wmOperatorType *ot)
   /* properties */
 }
 
-/***************** select linked pick operator ******************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Linked Pick Operator
+ * \{ */
 
 static int select_linked_pick_invoke(bContext *C, wmOperator *op, const wmEvent *event)
 {
@@ -740,7 +764,11 @@ void CURVE_OT_select_linked_pick(wmOperatorType *ot)
                   "Deselect linked control points rather than selecting them");
 }
 
-/***************** select row operator **********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Row Operator
+ * \{ */
 
 static int select_row_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -802,7 +830,11 @@ void CURVE_OT_select_row(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/***************** select next operator **********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Next Operator
+ * \{ */
 
 static int select_next_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -839,7 +871,11 @@ void CURVE_OT_select_next(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/***************** select previous operator **********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Previous Operator
+ * \{ */
 
 static int select_previous_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -876,7 +912,11 @@ void CURVE_OT_select_previous(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/***************** select more operator **********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select More Operator
+ * \{ */
 
 static void curve_select_more(Object *obedit)
 {
@@ -984,7 +1024,11 @@ void CURVE_OT_select_more(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/******************** select less operator *****************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Less Operator
+ * \{ */
 
 /* basic method: deselect if control point doesn't have all neighbors selected */
 static void curve_select_less(Object *obedit)
@@ -1198,7 +1242,11 @@ void CURVE_OT_select_less(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/********************** select random *********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Random Operator
+ * \{ */
 
 static int curve_select_random_exec(bContext *C, wmOperator *op)
 {
@@ -1312,7 +1360,11 @@ void CURVE_OT_select_random(wmOperatorType *ot)
   WM_operator_properties_select_random(ot);
 }
 
-/********************* every nth number of point *******************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Every Nth Number of Point Operator
+ * \{ */
 
 static void select_nth_bezt(Nurb *nu, BezTriple *bezt, const struct CheckerIntervalParams *params)
 {
@@ -1444,6 +1496,8 @@ void CURVE_OT_select_nth(wmOperatorType *ot)
   WM_operator_properties_checker_interval(ot, false);
 }
 
+/** \} */
+
 /* -------------------------------------------------------------------- */
 /** \name Select Similar Operator
  * \{ */