From 32b1a13fa1e427bc5b2cce2bf179fd274679e08f Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Wed, 8 Dec 2021 21:02:29 +1100
Subject: Cleanup: move public doc-strings into headers for 'sequencer'

Ref T92709
---
 source/blender/sequencer/SEQ_edit.h | 42 +++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

(limited to 'source/blender/sequencer/SEQ_edit.h')

diff --git a/source/blender/sequencer/SEQ_edit.h b/source/blender/sequencer/SEQ_edit.h
index f3a64c9cd62..c237ffea9c6 100644
--- a/source/blender/sequencer/SEQ_edit.h
+++ b/source/blender/sequencer/SEQ_edit.h
@@ -33,18 +33,40 @@ struct Scene;
 struct Sequence;
 
 int SEQ_edit_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
+/**
+ * Move sequence to seqbase.
+ *
+ * \param scene: Scene containing the editing
+ * \param dst_seqbase: seqbase where `seq` is located
+ * \param seq: Sequence to move
+ * \param dst_seqbase: Target seqbase
+ */
 bool SEQ_edit_move_strip_to_seqbase(struct Scene *scene,
                                     ListBase *seqbase,
                                     struct Sequence *src_seq,
                                     ListBase *dst_seqbase);
+/**
+ * Move sequence to meta sequence.
+ *
+ * \param scene: Scene containing the editing
+ * \param src_seq: Sequence to move
+ * \param dst_seqm: Target Meta sequence
+ * \param error_str: Error message
+ */
 bool SEQ_edit_move_strip_to_meta(struct Scene *scene,
                                  struct Sequence *src_seq,
                                  struct Sequence *dst_seqm,
                                  const char **error_str);
 bool SEQ_meta_separate(struct Scene *scene, struct Sequence *src_meta, const char **error_str);
+/**
+ * Flag seq and its users (effects) for removal.
+ */
 void SEQ_edit_flag_for_removal(struct Scene *scene,
                                struct ListBase *seqbase,
                                struct Sequence *seq);
+/**
+ * Remove all flagged sequences, return true if sequence is removed.
+ */
 void SEQ_edit_remove_flagged_sequences(struct Scene *scene, struct ListBase *seqbase);
 void SEQ_edit_update_muting(struct Editing *ed);
 
@@ -53,6 +75,17 @@ typedef enum eSeqSplitMethod {
   SEQ_SPLIT_HARD,
 } eSeqSplitMethod;
 
+/**
+ * Split Sequence at timeline_frame in two.
+ *
+ * \param bmain: Main in which Sequence is located
+ * \param scene: Scene in which Sequence is located
+ * \param seqbase: ListBase in which Sequence is located
+ * \param seq: Sequence to be split
+ * \param timeline_frame: frame at which seq is split.
+ * \param method: affects type of offset to be applied to resize Sequence
+ * \return The newly created sequence strip. This is always Sequence on right side.
+ */
 struct Sequence *SEQ_edit_strip_split(struct Main *bmain,
                                       struct Scene *scene,
                                       struct ListBase *seqbase,
@@ -60,6 +93,15 @@ struct Sequence *SEQ_edit_strip_split(struct Main *bmain,
                                       const int timeline_frame,
                                       const eSeqSplitMethod method,
                                       const char **r_error);
+/**
+ * Find gap after initial_frame and move strips on right side to close the gap
+ *
+ * \param scene: Scene in which strips are located
+ * \param seqbase: ListBase in which strips are located
+ * \param initial_frame: frame on timeline from where gaps are searched for
+ * \param remove_all_gaps: remove all gaps instead of one gap
+ * \return true if gap is removed, otherwise false
+ */
 bool SEQ_edit_remove_gaps(struct Scene *scene,
                           struct ListBase *seqbase,
                           const int initial_frame,
-- 
cgit v1.2.3