[Bf-blender-cvs] [846dde590f0] master: Cleanup: use doxy sections for sequencer edit, select

Campbell Barton noreply at git.blender.org
Fri Jun 5 16:13:35 CEST 2020


Commit: 846dde590f00087ebf26faaffcd520ceaed795d0
Author: Campbell Barton
Date:   Sat Jun 6 00:05:54 2020 +1000
Branches: master
https://developer.blender.org/rB846dde590f00087ebf26faaffcd520ceaed795d0

Cleanup: use doxy sections for sequencer edit, select

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

M	source/blender/editors/space_sequencer/sequencer_edit.c
M	source/blender/editors/space_sequencer/sequencer_select.c

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

diff --git a/source/blender/editors/space_sequencer/sequencer_edit.c b/source/blender/editors/space_sequencer/sequencer_edit.c
index ea0d5785d22..28ded81eeae 100644
--- a/source/blender/editors/space_sequencer/sequencer_edit.c
+++ b/source/blender/editors/space_sequencer/sequencer_edit.c
@@ -71,7 +71,10 @@
 /* Own include. */
 #include "sequencer_intern.h"
 
-/* XXX */
+/* -------------------------------------------------------------------- */
+/** \name Structs & Enums
+ * \{ */
+
 /* RNA Enums, used in multiple files. */
 EnumPropertyItem sequencer_prop_effect_types[] = {
     {SEQ_TYPE_CROSS, "CROSS", 0, "Crossfade", "Crossfade effect strip type"},
@@ -122,9 +125,11 @@ typedef struct TransSeq {
   int len;
 } TransSeq;
 
-/* ********************************************************************** */
+/** \} */
 
-/* ***************** proxy job manager ********************** */
+/* -------------------------------------------------------------------- */
+/** \name Proxy Job Manager
+ * \{ */
 
 typedef struct ProxyBuildJob {
   struct Main *main;
@@ -256,7 +261,11 @@ static void seq_proxy_build_job(const bContext *C, ReportList *reports)
   ED_area_tag_redraw(area);
 }
 
-/* ********************************************************************** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Sequence Query Utilities
+ * \{ */
 
 void seq_rectf(Sequence *seq, rctf *rect)
 {
@@ -487,6 +496,12 @@ static bool seq_is_predecessor(Sequence *pred, Sequence *seq)
   return 0;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Selection Utilities
+ * \{ */
+
 void ED_sequencer_deselect_all(Scene *scene)
 {
   Sequence *seq;
@@ -527,6 +542,12 @@ void recurs_sel_seq(Sequence *seqm)
   }
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Public Context Checks
+ * \{ */
+
 bool ED_space_sequencer_maskedit_mask_poll(bContext *C)
 {
   return ED_space_sequencer_maskedit_poll(C);
@@ -566,6 +587,12 @@ bool ED_space_sequencer_check_show_strip(SpaceSeq *sseq)
           ELEM(sseq->mainb, SEQ_DRAW_SEQUENCE, SEQ_DRAW_IMG_IMBUF));
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Find Selected Strips as Inputs to an Effects Strip
+ * \{ */
+
 int seq_effect_find_selected(Scene *scene,
                              Sequence *activeseq,
                              int type,
@@ -654,6 +681,12 @@ int seq_effect_find_selected(Scene *scene,
   return 1;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Delete Utilities
+ * \{ */
+
 static Sequence *del_seq_find_replace_recurs(Scene *scene, Sequence *seq)
 {
   Sequence *seq1, *seq2, *seq3;
@@ -748,6 +781,12 @@ static void recurs_del_seq_flag(Scene *scene, ListBase *lb, short flag, short de
   }
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Split (Hard) Utility
+ * \{ */
+
 static Sequence *split_seq_hard(
     Main *bmain, Scene *scene, Sequence *seq, ListBase *new_seq_list, int split_frame)
 {
@@ -865,6 +904,12 @@ static Sequence *split_seq_hard(
   return seqn;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Split (Soft) Utility
+ * \{ */
+
 static Sequence *split_seq_soft(
     Main *UNUSED(bmain), Scene *scene, Sequence *seq, ListBase *new_seq_list, int split_frame)
 {
@@ -1130,6 +1175,12 @@ static void UNUSED_FUNCTION(seq_remap_paths)(Scene *scene)
   SEQ_END;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Remove Gaps Operator
+ * \{ */
+
 static int sequencer_gap_remove_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -1198,6 +1249,12 @@ void SEQUENCER_OT_gap_remove(struct wmOperatorType *ot)
   RNA_def_boolean(ot->srna, "all", 0, "All Gaps", "Do all gaps to right of current frame");
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Insert Gaps Operator
+ * \{ */
+
 static int sequencer_gap_insert_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -1238,6 +1295,12 @@ void SEQUENCER_OT_gap_insert(struct wmOperatorType *ot)
               1000);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Shared Poll Functions
+ * \{ */
+
 #if 0
 static int seq_get_snaplimit(View2D *v2d)
 {
@@ -1298,7 +1361,12 @@ bool sequencer_view_strips_poll(bContext *C)
   return 0;
 }
 
-/* Snap operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Snap Strips to the Current Frame Operator
+ * \{ */
+
 static int sequencer_snap_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -1399,6 +1467,12 @@ void SEQUENCER_OT_snap(struct wmOperatorType *ot)
               INT_MAX);
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Trim Strips Operator
+ * \{ */
+
 typedef struct SlipData {
   int init_mouse[2];
   float init_mouseloc[2];
@@ -1855,7 +1929,12 @@ void SEQUENCER_OT_slip(struct wmOperatorType *ot)
               INT32_MAX);
 }
 
-/* Mute operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Mute Strips Operator
+ * \{ */
+
 static int sequencer_mute_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -1906,7 +1985,12 @@ void SEQUENCER_OT_mute(struct wmOperatorType *ot)
       ot->srna, "unselected", 0, "Unselected", "Mute unselected rather than selected strips");
 }
 
-/* Unmute operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Unmute Strips Operator
+ * \{ */
+
 static int sequencer_unmute_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -1957,7 +2041,12 @@ void SEQUENCER_OT_unmute(struct wmOperatorType *ot)
       ot->srna, "unselected", 0, "Unselected", "Unmute unselected rather than selected strips");
 }
 
-/* Lock operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Lock Strips Operator
+ * \{ */
+
 static int sequencer_lock_exec(bContext *C, wmOperator *UNUSED(op))
 {
   Scene *scene = CTX_data_scene(C);
@@ -1990,7 +2079,12 @@ void SEQUENCER_OT_lock(struct wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* Unlock operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Unlock Strips Operator
+ * \{ */
+
 static int sequencer_unlock_exec(bContext *C, wmOperator *UNUSED(op))
 {
   Scene *scene = CTX_data_scene(C);
@@ -2023,7 +2117,12 @@ void SEQUENCER_OT_unlock(struct wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* Reload operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Reload Strips Operator
+ * \{ */
+
 static int sequencer_reload_exec(bContext *C, wmOperator *op)
 {
   Main *bmain = CTX_data_main(C);
@@ -2074,7 +2173,12 @@ void SEQUENCER_OT_reload(struct wmOperatorType *ot)
   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
-/* Reload operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Refresh Sequencer Operator
+ * \{ */
+
 static bool sequencer_refresh_all_poll(bContext *C)
 {
   if (G.is_rendering) {
@@ -2107,6 +2211,12 @@ void SEQUENCER_OT_refresh_all(struct wmOperatorType *ot)
   ot->poll = sequencer_refresh_all_poll;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Reassign Inputs Operator
+ * \{ */
+
 static int sequencer_reassign_inputs_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -2166,6 +2276,12 @@ void SEQUENCER_OT_reassign_inputs(struct wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Swap Inputs Operator
+ * \{ */
+
 static int sequencer_swap_inputs_exec(bContext *C, wmOperator *op)
 {
   Scene *scene = CTX_data_scene(C);
@@ -2201,7 +2317,12 @@ void SEQUENCER_OT_swap_inputs(struct wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* Split operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Split Strips Operator
+ * \{ */
+
 static const EnumPropertyItem prop_split_types[] = {
     {SEQ_SPLIT_SOFT, "SOFT", 0, "Soft", ""},
     {SEQ_SPLIT_HARD, "HARD", 0, "Hard", ""},
@@ -2397,7 +2518,12 @@ void SEQUENCER_OT_split(struct wmOperatorType *ot)
 
 #undef SEQ_SIDE_MOUSE
 
-/* Duplicate operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Duplicate Strips Operator
+ * \{ */
+
 static int apply_unique_name_fn(Sequence *seq, void *arg_pt)
 {
   Scene *scene = (Scene *)arg_pt;
@@ -2453,7 +2579,12 @@ void SEQUENCER_OT_duplicate(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* Delete operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Erase Strips Operator
+ * \{ */
+
 static int sequencer_delete_exec(bContext *C, wmOperator *UNUSED(op))
 {
   Main *bmain = CTX_data_main(C);
@@ -2549,7 +2680,12 @@ void SEQUENCER_OT_delete(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* Offset clear operator. */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Clear Strip Offset Operator
+ * \{ */
+
 static int sequencer_offset_clear_exec(bContext *C, wmOperator *UNUSED(op))
 {
   Scene *scene = CTX_data_scene(C);
@@ -2599,7 +2735,12 @@ void SEQUENCER_OT_offset_clear(wmOperatorType *ot)
   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
 }
 
-/* Separate_images operator. */
+/** \} */
+
+/* --------------------------------------------------------------------

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list