[Bf-blender-cvs] [b4c05a9c893] master: Cleanup: use doxy sections

Campbell Barton noreply at git.blender.org
Wed Mar 25 11:52:14 CET 2020


Commit: b4c05a9c89358fb14715009923241efdd007d3dc
Author: Campbell Barton
Date:   Wed Mar 25 21:24:59 2020 +1100
Branches: master
https://developer.blender.org/rBb4c05a9c89358fb14715009923241efdd007d3dc

Cleanup: use doxy sections

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

M	source/blender/editors/armature/armature_edit.c
M	source/blender/editors/space_file/file_intern.h
M	source/blender/editors/space_file/file_ops.c
M	source/blender/editors/space_image/image_ops.c

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

diff --git a/source/blender/editors/armature/armature_edit.c b/source/blender/editors/armature/armature_edit.c
index 4285c7779d7..b8378c95a60 100644
--- a/source/blender/editors/armature/armature_edit.c
+++ b/source/blender/editors/armature/armature_edit.c
@@ -61,7 +61,10 @@
 
 #include "armature_intern.h"
 
-/* ************************** Object Tools Exports ******************************* */
+/* -------------------------------------------------------------------- */
+/** \name Object Tools Public API
+ * \{ */
+
 /* NOTE: these functions are exported to the Object module to be called from the tools there */
 
 /**
@@ -178,7 +181,11 @@ void ED_armature_origin_set(
   }
 }
 
-/* ********************************* Roll ******************************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Bone Roll Calculate Operator
+ * \{ */
 
 /* adjust bone roll to align Z axis with vector
  * vec is in local space and is normalized
@@ -549,7 +556,11 @@ void ARMATURE_OT_roll_clear(wmOperatorType *ot)
                          DEG2RADF(360.0f));
 }
 
-/* ******************************** Chain-Based Tools ********************************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Chain-Based Tool Utilities
+ * \{ */
 
 /* temporary data-structure for merge/fill bones */
 typedef struct EditBonePoint {
@@ -616,7 +627,11 @@ static void chains_find_tips(ListBase *edbo, ListBase *list)
   }
 }
 
-/* --------------------- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Fill Operator
+ * \{ */
 
 static void fill_add_joint(EditBone *ebo, short eb_tail, ListBase *points)
 {
@@ -871,7 +886,11 @@ void ARMATURE_OT_fill(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* --------------------- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Merge Operator
+ * \{ */
 
 /* this function merges between two bones, removes them and those in-between,
  * and adjusts the parent relationships for those in-between
@@ -1074,13 +1093,15 @@ void ARMATURE_OT_merge(wmOperatorType *ot)
   ot->prop = RNA_def_enum(ot->srna, "type", merge_types, 0, "Type", "");
 }
 
-/* --------------------- */
+/** \} */
 
-/* Switch Direction operator:
+/* -------------------------------------------------------------------- */
+/** \name Switch Direction Operator
+ *
  * Currently, this does not use context loops, as context loops do not make it
  * easy to retrieve any hierarchical/chain relationships which are necessary for
  * this to be done easily.
- */
+ * \{ */
 
 /* helper to clear BONE_TRANSFORM flags */
 static void armature_clear_swap_done_flags(bArmature *arm)
@@ -1210,7 +1231,11 @@ void ARMATURE_OT_switch_direction(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ********************************* Align ******************************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Align Operator
+ * \{ */
 
 /* helper to fix a ebone position if its parent has moved due to alignment*/
 static void fix_connected_bone(EditBone *ebone)
@@ -1354,7 +1379,11 @@ void ARMATURE_OT_align(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ********************************* Split ******************************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Split Operator
+ * \{ */
 
 static int armature_split_exec(bContext *C, wmOperator *UNUSED(op))
 {
@@ -1400,7 +1429,11 @@ void ARMATURE_OT_split(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ********************************* Delete ******************************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Delete Operator
+ * \{ */
 
 static bool armature_delete_ebone_cb(const char *bone_name, void *arm_p)
 {
@@ -1658,7 +1691,11 @@ void ARMATURE_OT_dissolve(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* ********************************* Show/Hide ******************************* */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Hide Operator
+ * \{ */
 
 static int armature_hide_exec(bContext *C, wmOperator *op)
 {
@@ -1719,6 +1756,12 @@ void ARMATURE_OT_hide(wmOperatorType *ot)
   RNA_def_boolean(ot->srna, "unselected", 0, "Unselected", "Hide unselected rather than selected");
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Reveal Operator
+ * \{ */
+
 static int armature_reveal_exec(bContext *C, wmOperator *op)
 {
   ViewLayer *view_layer = CTX_data_view_layer(C);
@@ -1771,3 +1814,5 @@ void ARMATURE_OT_reveal(wmOperatorType *ot)
 
   RNA_def_boolean(ot->srna, "select", true, "Select", "");
 }
+
+/** \} */
diff --git a/source/blender/editors/space_file/file_intern.h b/source/blender/editors/space_file/file_intern.h
index 6ef35132087..b7e8d35ffee 100644
--- a/source/blender/editors/space_file/file_intern.h
+++ b/source/blender/editors/space_file/file_intern.h
@@ -75,14 +75,6 @@ void FILE_OT_smoothscroll(struct wmOperatorType *ot);
 void FILE_OT_filepath_drop(struct wmOperatorType *ot);
 void FILE_OT_start_filter(struct wmOperatorType *ot);
 
-int file_exec(bContext *C, struct wmOperator *exec_op);
-int file_cancel_exec(bContext *C, struct wmOperator *unused);
-int file_parent_exec(bContext *C, struct wmOperator *unused);
-int file_previous_exec(bContext *C, struct wmOperator *unused);
-int file_next_exec(bContext *C, struct wmOperator *unused);
-int file_directory_new_exec(bContext *C, struct wmOperator *unused);
-int file_delete_exec(bContext *C, struct wmOperator *unused);
-
 void file_directory_enter_handle(bContext *C, void *arg_unused, void *arg_but);
 void file_filename_enter_handle(bContext *C, void *arg_unused, void *arg_but);
 
diff --git a/source/blender/editors/space_file/file_ops.c b/source/blender/editors/space_file/file_ops.c
index c17ca31a7df..a34fcba99be 100644
--- a/source/blender/editors/space_file/file_ops.c
+++ b/source/blender/editors/space_file/file_ops.c
@@ -68,7 +68,10 @@
 #include <stdlib.h>
 #include <string.h>
 
-/* ---------- FILE SELECTION ------------ */
+/* -------------------------------------------------------------------- */
+/** \name File Selection Utilities
+ * \{ */
+
 static FileSelection find_file_mouse_rect(SpaceFile *sfile,
                                           ARegion *region,
                                           const rcti *rect_region)
@@ -344,6 +347,12 @@ static FileSelect file_select(
   return retval;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Box Select Operator
+ * \{ */
+
 static int file_box_select_find_last_selected(SpaceFile *sfile,
                                               ARegion *region,
                                               const FileSelection *sel,
@@ -484,6 +493,12 @@ void FILE_OT_select_box(wmOperatorType *ot)
   WM_operator_properties_select_operation_simple(ot);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Pick Operator
+ * \{ */
+
 static int file_select_invoke(bContext *C, wmOperator *op, const wmEvent *event)
 {
   ARegion *region = CTX_wm_region(C);
@@ -577,6 +592,12 @@ void FILE_OT_select(wmOperatorType *ot)
   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Walk Operator
+ * \{ */
+
 /**
  * \returns true if selection has changed
  */
@@ -822,6 +843,12 @@ void FILE_OT_select_walk(wmOperatorType *ot)
   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select All Operator
+ * \{ */
+
 static int file_select_all_exec(bContext *C, wmOperator *op)
 {
   ScrArea *sa = CTX_wm_area(C);
@@ -893,7 +920,11 @@ void FILE_OT_select_all(wmOperatorType *ot)
   WM_operator_properties_select_all(ot);
 }
 
-/* ---------- BOOKMARKS ----------- */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Select Bookmark Operator
+ * \{ */
 
 /* Note we could get rid of this one, but it's used by some addon so...
  * Does not hurt keeping it around for now. */
@@ -936,6 +967,12 @@ void FILE_OT_select_bookmark(wmOperatorType *ot)
   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Add Bookmark Operator
+ * \{ */
+
 static int bookmark_add_exec(bContext *C, wmOperator *UNUSED(op))
 {
   ScrArea *sa = CTX_wm_area(C);
@@ -972,6 +1009,12 @@ void FILE_OT_bookmark_add(wmOperatorType *ot)
   ot->poll = ED_operator_file_active;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Delete Bookmark Operator
+ * \{ */
+
 static int bookmark_delete_exec(bContext *C, wmOperator *op)
 {
   ScrArea *sa = CTX_wm_area(C);
@@ -1024,6 +1067,12 @@ void FILE_OT_bookmark_delete(wmOperatorType *ot)
   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Cleanup Bookmark Operator
+ * \{ */
+
 static int bookmark_cleanup_exec(bContext *C, wmOperator *UNUSED(op))
 {
   ScrArea *sa = CTX_wm_area(C);
@@ -1074,6 +1123,12 @@ void FILE_OT_bookmark_cleanup(wmOperatorType *ot)
   /* properties */
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Reorder Bookmark Operator
+ * \{ */
+
 enum {
   FILE_BOOKMARK_MOVE_TOP = -2,
   FILE_BOOKMARK_MOVE_UP = -1,
@@ -1165,6 +1220,12 @@ void FILE_OT_bookmark_move(wmOperatorType *ot)
                "Direction to move the active bookmark towards");
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Reset Recent Blend Files Oper

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list