[Bf-blender-cvs] [2a868d277e3] master: Cleanup: use doxy sections for node_relationships.cc

[Campbell Barton]

Commit: 2a868d277e323df32195d42e52d49d80502a6bde
Author: Campbell Barton
Date:   Thu Jun 3 10:35:46 2021 +1000
Branches: master
https://developer.blender.org/rB2a868d277e323df32195d42e52d49d80502a6bde

Cleanup: use doxy sections for node_relationships.cc

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

M	source/blender/editors/space_node/node_relationships.cc

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

diff --git a/source/blender/editors/space_node/node_relationships.cc b/source/blender/editors/space_node/node_relationships.cc
index 212724dc39a..9a931176e42 100644
--- a/source/blender/editors/space_node/node_relationships.cc
+++ b/source/blender/editors/space_node/node_relationships.cc
@@ -55,7 +55,9 @@
 
 #include "node_intern.h" /* own include */
 
-/* ****************** Relations helpers *********************** */
+/* -------------------------------------------------------------------- */
+/** \name Relations Helpers
+ * \{ */
 
 static bool ntree_has_drivers(bNodeTree *ntree)
 {
@@ -162,7 +164,11 @@ bool node_connected_to_output(Main *bmain, bNodeTree *ntree, bNode *node)
   return false;
 }
 
-/* ****************** Add *********************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Add Node
+ * \{ */
 
 struct bNodeListItem {
   struct bNodeListItem *next, *prev;
@@ -590,7 +596,11 @@ static void snode_autoconnect(Main *bmain,
   MEM_freeN(nodelist);
 }
 
-/* *************************** link viewer op ******************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Link Viewer Operator
+ * \{ */
 
 static int node_link_viewer(const bContext *C, bNode *tonode)
 {
@@ -744,7 +754,11 @@ void NODE_OT_link_viewer(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* *************************** add link op ******************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Add Link Operator
+ * \{ */
 
 static void node_link_update_header(bContext *C, bNodeLinkDrag *UNUSED(nldrag))
 {
@@ -1181,7 +1195,11 @@ void NODE_OT_link(wmOperatorType *ot)
   RNA_def_property_flag(prop, PROP_HIDDEN);
 }
 
-/* ********************** Make Link operator ***************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Make Link Operator
+ * \{ */
 
 /* makes a link between selected output and input sockets */
 static int node_make_link_exec(bContext *C, wmOperator *op)
@@ -1224,7 +1242,12 @@ void NODE_OT_link_make(wmOperatorType *ot)
       ot->srna, "replace", false, "Replace", "Replace socket connections with the new links");
 }
 
-/* ********************** Node Link Intersect ***************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Node Link Intersect
+ * \{ */
+
 static bool node_links_intersect(bNodeLink *link, const float mcoords[][2], int tot)
 {
   float coord_array[NODE_LINK_RESOL + 1][2];
@@ -1241,7 +1264,12 @@ static bool node_links_intersect(bNodeLink *link, const float mcoords[][2], int
   return false;
 }
 
-/* ********************** Cut Link operator ***************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Cut Link Operator
+ * \{ */
+
 static int cut_links_exec(bContext *C, wmOperator *op)
 {
   Main *bmain = CTX_data_main(C);
@@ -1333,7 +1361,11 @@ void NODE_OT_links_cut(wmOperatorType *ot)
   RNA_def_int(ot->srna, "cursor", WM_CURSOR_KNIFE, 0, INT_MAX, "Cursor", "", 0, INT_MAX);
 }
 
-/* ********************** Mute links operator ***************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Mute Links Operator
+ * \{ */
 
 static int mute_links_exec(bContext *C, wmOperator *op)
 {
@@ -1435,7 +1467,11 @@ void NODE_OT_links_mute(wmOperatorType *ot)
   RNA_def_int(ot->srna, "cursor", WM_CURSOR_MUTE, 0, INT_MAX, "Cursor", "", 0, INT_MAX);
 }
 
-/* ********************** Detach links operator ***************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Detach Links Operator
+ * \{ */
 
 static int detach_links_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -1472,7 +1508,11 @@ void NODE_OT_links_detach(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ****************** Set Parent ******************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Set Parent Operator
+ * \{ */
 
 static int node_parent_set_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -1514,7 +1554,11 @@ void NODE_OT_parent_set(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ****************** Join Nodes ******************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Join Nodes Operator
+ * \{ */
 
 /* tags for depth-first search */
 #define NODE_JOIN_DONE 1
@@ -1607,7 +1651,11 @@ void NODE_OT_join(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ****************** Attach ******************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Attach Operator
+ * \{ */
 
 static bNode *node_find_frame_to_attach(ARegion *region,
                                         const bNodeTree *ntree,
@@ -1690,7 +1738,11 @@ void NODE_OT_attach(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ****************** Detach ******************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Detach Operator
+ * \{ */
 
 /* tags for depth-first search */
 #define NODE_DETACH_DONE 1
@@ -1761,7 +1813,11 @@ void NODE_OT_detach(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* *********************  automatic node insert on dragging ******************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Automatic Node Insert on Dragging
+ * \{ */
 
 /* prevent duplicate testing code below */
 static bool ed_node_link_conditions(ScrArea *area,
@@ -1879,6 +1935,12 @@ void ED_node_link_intersect_test(ScrArea *area, int test)
   }
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Node Insert Offset Operator
+ * \{ */
+
 static int get_main_socket_priority(const bNodeSocket *socket)
 {
   switch ((eNodeSocketDatatype)socket->type) {
@@ -2263,6 +2325,12 @@ void NODE_OT_insert_offset(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Note Link Insert
+ * \{ */
+
 /* assumes link with NODE_LINKFLAG_HILITE set */
 void ED_node_link_insert(Main *bmain, ScrArea *area)
 {
@@ -2319,3 +2387,5 @@ void ED_node_link_insert(Main *bmain, ScrArea *area)
     }
   }
 }
+
+/** \} */