From 2da649cc50b552996bd790dadc27ad1af437800f Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Sat, 13 Feb 2021 16:50:14 +1100
Subject: Cleanup: use doxy sections

---
 source/blender/blenkernel/intern/tracking_util.c | 24 +++++++++++++++----
 source/blender/editors/space_clip/clip_editor.c  | 30 ++++++++++++++++++++----
 2 files changed, 45 insertions(+), 9 deletions(-)

(limited to 'source/blender')

diff --git a/source/blender/blenkernel/intern/tracking_util.c b/source/blender/blenkernel/intern/tracking_util.c
index ad2713b9977..ea0d92cf78e 100644
--- a/source/blender/blenkernel/intern/tracking_util.c
+++ b/source/blender/blenkernel/intern/tracking_util.c
@@ -60,7 +60,9 @@
 #  define CACHE_PRINTF(...)
 #endif
 
-/*********************** Tracks map *************************/
+/* -------------------------------------------------------------------- */
+/** \name Tracks Map
+ * \{ */
 
 TracksMap *tracks_map_new(const char *object_name,
                           bool is_camera,
@@ -242,7 +244,11 @@ void tracks_map_free(TracksMap *map, void (*customdata_free)(void *customdata))
   MEM_freeN(map);
 }
 
-/*********************** Space transformation functions *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Space Transformation Functions
+ * \{ */
 
 /* Three coordinate frames: Frame, Search, and Marker
  * Two units: Pixels, Unified
@@ -399,7 +405,11 @@ void tracking_set_marker_coords_from_tracking(int frame_width,
   marker->pos[1] += marker_unified[1];
 }
 
-/*********************** General purpose utility functions *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name General Purpose Utility Functions
+ * \{ */
 
 /* Place a disabled marker before or after specified ref_marker.
  *
@@ -613,7 +623,11 @@ MovieTrackingMarker *tracking_get_keyframed_marker(MovieTrackingTrack *track,
   return marker_keyed;
 }
 
-/*********************** Frame accessr *************************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Frame Accessor
+ * \{ */
 
 static ImBuf *accessor_get_preprocessed_ibuf(TrackingImageAccessor *accessor,
                                              int clip_index,
@@ -936,3 +950,5 @@ void tracking_image_accessor_destroy(TrackingImageAccessor *accessor)
   MEM_freeN(accessor->tracks);
   MEM_freeN(accessor);
 }
+
+/** \} */
diff --git a/source/blender/editors/space_clip/clip_editor.c b/source/blender/editors/space_clip/clip_editor.c
index af1d082d317..e1172458f67 100644
--- a/source/blender/editors/space_clip/clip_editor.c
+++ b/source/blender/editors/space_clip/clip_editor.c
@@ -67,7 +67,9 @@
 
 #include "clip_intern.h" /* own include */
 
-/* ******** operactor poll functions ******** */
+/* -------------------------------------------------------------------- */
+/** \name Operator Poll Functions
+ * \{ */
 
 bool ED_space_clip_poll(bContext *C)
 {
@@ -128,7 +130,11 @@ bool ED_space_clip_maskedit_mask_poll(bContext *C)
   return false;
 }
 
-/* ******** common editing functions ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Common Editing Functions
+ * \{ */
 
 void ED_space_clip_get_size(SpaceClip *sc, int *width, int *height)
 {
@@ -538,7 +544,11 @@ bool ED_space_clip_check_show_maskedit(SpaceClip *sc)
   return false;
 }
 
-/* ******** clip editing functions ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Clip Editing Functions
+ * \{ */
 
 MovieClip *ED_space_clip_get_clip(SpaceClip *sc)
 {
@@ -595,7 +605,11 @@ void ED_space_clip_set_clip(bContext *C, bScreen *screen, SpaceClip *sc, MovieCl
   }
 }
 
-/* ******** masking editing functions ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Masking Editing Functions
+ * \{ */
 
 Mask *ED_space_clip_get_mask(SpaceClip *sc)
 {
@@ -613,7 +627,11 @@ void ED_space_clip_set_mask(bContext *C, SpaceClip *sc, Mask *mask)
   }
 }
 
-/* ******** pre-fetching functions ******** */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Pre-Fetching Functions
+ * \{ */
 
 typedef struct PrefetchJob {
   MovieClip *clip;
@@ -1121,3 +1139,5 @@ void ED_clip_view_lock_state_restore_no_jump(const bContext *C, const ClipViewLo
   space_clip->xlockof = state->offset_x + state->lock_offset_x - offset_x;
   space_clip->ylockof = state->offset_y + state->lock_offset_y - offset_y;
 }
+
+/** \} */
-- 
cgit v1.2.3