From 61776befc3f88c373e47ccbdf8c75e2ca0f4e987 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Thu, 9 Dec 2021 00:55:11 +1100
Subject: Cleanup: move public doc-strings into headers for 'editors'

Ref T92709
---
 .../blender/editors/transform/transform_convert.c  | 36 +++-------------------
 1 file changed, 4 insertions(+), 32 deletions(-)

(limited to 'source/blender/editors/transform/transform_convert.c')

diff --git a/source/blender/editors/transform/transform_convert.c b/source/blender/editors/transform/transform_convert.c
index ff20f569a71..8f3d13176a3 100644
--- a/source/blender/editors/transform/transform_convert.c
+++ b/source/blender/editors/transform/transform_convert.c
@@ -68,10 +68,6 @@ bool transform_mode_use_local_origins(const TransInfo *t)
   return ELEM(t->mode, TFM_ROTATION, TFM_RESIZE, TFM_TRACKBALL);
 }
 
-/**
- * Transforming around ourselves is no use, fallback to individual origins,
- * useful for curve/armatures.
- */
 void transform_around_single_fallback_ex(TransInfo *t, int data_len_all)
 {
   if (data_len_all != 1) {
@@ -369,7 +365,6 @@ static bool pchan_autoik_adjust(bPoseChannel *pchan, short chainlen)
   return changed;
 }
 
-/* change the chain-length of auto-ik */
 void transform_autoik_update(TransInfo *t, short mode)
 {
   Main *bmain = CTX_data_main(t->context);
@@ -482,7 +477,6 @@ void calc_distanceCurveVerts(TransData *head, TransData *tail, bool cyclic)
   BLI_LINKSTACK_FREE(queue);
 }
 
-/* Utility function for getting the handle data from bezier's */
 TransDataCurveHandleFlags *initTransDataCurveHandles(TransData *td, struct BezTriple *bezt)
 {
   TransDataCurveHandleFlags *hdata;
@@ -611,9 +605,6 @@ void clipUVData(TransInfo *t)
 /** \name Animation Editors (General)
  * \{ */
 
-/**
- * Used for `TFM_TIME_EXTEND`.
- */
 char transform_convert_frame_side_dir_get(TransInfo *t, float cframe)
 {
   char r_dir;
@@ -636,7 +627,6 @@ char transform_convert_frame_side_dir_get(TransInfo *t, float cframe)
   return r_dir;
 }
 
-/* This function tests if a point is on the "mouse" side of the cursor/frame-marking */
 bool FrameOnMouseSide(char side, float frame, float cframe)
 {
   /* both sides, so it doesn't matter */
@@ -667,14 +657,6 @@ typedef struct tRetainedKeyframe {
   size_t del_count; /* number of keyframes of this sort that have been deleted so far */
 } tRetainedKeyframe;
 
-/**
- * Called during special_aftertrans_update to make sure selected keyframes replace
- * any other keyframes which may reside on that frame (that is not selected).
- *
- * \param sel_flag: The flag (bezt.f1/2/3) value to use to determine selection. Usually `SELECT`,
- *                  but may want to use a different one at times (if caller does not operate on
- *                  selection).
- */
 void posttrans_fcurve_clean(FCurve *fcu, const int sel_flag, const bool use_handle)
 {
   /* NOTE: We assume that all keys are sorted */
@@ -798,12 +780,6 @@ void posttrans_fcurve_clean(FCurve *fcu, const int sel_flag, const bool use_hand
 /** \name Transform Utilities
  * \{ */
 
-/* Little helper function for ObjectToTransData used to give certain
- * constraints (ChildOf, FollowPath, and others that may be added)
- * inverse corrections for transform, so that they aren't in CrazySpace.
- * These particular constraints benefit from this, but others don't, hence
- * this semi-hack ;-)    - Aligorith
- */
 bool constraints_list_needinv(TransInfo *t, ListBase *list)
 {
   bConstraint *con;
@@ -894,14 +870,12 @@ bool constraints_list_needinv(TransInfo *t, ListBase *list)
 /** \name Transform (After-Transform Update)
  * \{ */
 
-/* inserting keys, pointcache, redraw events... */
-/**
- * \note Sequencer freeing has its own function now because of a conflict
- * with transform's order of freeing (campbell).
- * Order changed, the sequencer stuff should go back in here
- */
 void special_aftertrans_update(bContext *C, TransInfo *t)
 {
+  /* NOTE: Sequencer freeing has its own function now because of a conflict
+   * with transform's order of freeing (campbell).
+   * Order changed, the sequencer stuff should go back in here. */
+
   /* early out when nothing happened */
   if (t->data_len_all == 0 || t->mode == TFM_DUMMY) {
     return;
@@ -1609,7 +1583,6 @@ void transform_convert_clip_mirror_modifier_apply(TransDataContainer *tc)
   }
 }
 
-/* for the realtime animation recording feature, handle overlapping data */
 void animrecord_check_state(TransInfo *t, struct Object *ob)
 {
   Scene *scene = t->scene;
@@ -1708,7 +1681,6 @@ void transform_convert_flush_handle2D(TransData *td, TransData2D *td2d, const fl
   }
 }
 
-/* called for updating while transform acts, once per redraw */
 void recalcData(TransInfo *t)
 {
   switch (t->data_type) {
-- 
cgit v1.2.3