[Bf-blender-cvs] [2d39e46f84f] master: Cleanup: use doxy sections for wm_draw.c

[Campbell Barton]

Commit: 2d39e46f84ffd28892deb6a93f099c051d16c95f
Author: Campbell Barton
Date:   Wed Apr 1 11:08:01 2020 +1100
Branches: master
https://developer.blender.org/rB2d39e46f84ffd28892deb6a93f099c051d16c95f

Cleanup: use doxy sections for wm_draw.c

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

M	source/blender/windowmanager/intern/wm_draw.c

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

diff --git a/source/blender/windowmanager/intern/wm_draw.c b/source/blender/windowmanager/intern/wm_draw.c
index 6df8440f90f..ebfdd8a5f6a 100644
--- a/source/blender/windowmanager/intern/wm_draw.c
+++ b/source/blender/windowmanager/intern/wm_draw.c
@@ -73,7 +73,9 @@
 #  include "BKE_subsurf.h"
 #endif
 
-/* ******************* paint cursor *************** */
+/* -------------------------------------------------------------------- */
+/** \name Draw Paint Cursor
+ * \{ */
 
 static void wm_paintcursor_draw(bContext *C, ScrArea *sa, ARegion *region)
 {
@@ -116,6 +118,12 @@ static void wm_paintcursor_draw(bContext *C, ScrArea *sa, ARegion *region)
   }
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Internal Utilities
+ * \{ */
+
 static bool wm_draw_region_stereo_set(Main *bmain,
                                       ScrArea *sa,
                                       ARegion *region,
@@ -184,8 +192,6 @@ static bool wm_draw_region_stereo_set(Main *bmain,
   return false;
 }
 
-/* ********************* drawing ****************** */
-
 static void wm_area_mark_invalid_backbuf(ScrArea *sa)
 {
   if (sa->spacetype == SPACE_VIEW3D) {
@@ -286,8 +292,13 @@ static bool wm_region_use_viewport(ScrArea *sa, ARegion *region)
   return wm_region_use_viewport_by_type(sa->spacetype, region->regiontype);
 }
 
-/********************** draw all **************************/
-/* - reference method, draw all each time                 */
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Window Drawing (Draw All)
+ *
+ * Reference method, draw all each time.
+ * \{ */
 
 typedef struct WindowDrawCB {
   struct WindowDrawCB *next, *prev;
@@ -328,12 +339,16 @@ static void wm_draw_callbacks(wmWindow *win)
   }
 }
 
-/************************* Region drawing. ********************************
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Region Drawing
  *
- * Each region draws into its own framebuffer, which is then blit on the
+ * Each region draws into its own frame-buffer, which is then blit on the
  * window draw buffer. This helps with fast redrawing if only some regions
  * change. It also means we can share a single context for multiple windows,
- * so that for example VAOs can be shared between windows. */
+ * so that for example VAOs can be shared between windows.
+ * \{ */
 
 static void wm_draw_region_buffer_free(ARegion *region)
 {
@@ -866,7 +881,11 @@ static void wm_draw_surface(bContext *C, wmSurface *surface)
   wm_surface_clear_drawable();
 }
 
-/****************** main update call **********************/
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Main Update Call
+ * \{ */
 
 /* quick test to prevent changing window drawable */
 static bool wm_draw_update_test_window(Main *bmain, bContext *C, wmWindow *win)
@@ -1042,6 +1061,8 @@ void WM_redraw_windows(bContext *C)
   CTX_wm_region_set(C, ar_prev);
 }
 
+/** \} */
+
 /* -------------------------------------------------------------------- */
 /** \name Region Viewport Drawing
  *