[Bf-blender-cvs] [733bcbed46e] master: Cleanup: Comment formatting, grammar

[Hans Goudey]

Commit: 733bcbed46ed46fba10bc95c09d4dab22f32ac69
Author: Hans Goudey
Date:   Tue Jan 26 15:09:02 2021 -0600
Branches: master
https://developer.blender.org/rB733bcbed46ed46fba10bc95c09d4dab22f32ac69

Cleanup: Comment formatting, grammar

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

M	source/blender/editors/space_api/spacetypes.c

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

diff --git a/source/blender/editors/space_api/spacetypes.c b/source/blender/editors/space_api/spacetypes.c
index d8e7e27a0ab..01e57eab7c2 100644
--- a/source/blender/editors/space_api/spacetypes.c
+++ b/source/blender/editors/space_api/spacetypes.c
@@ -70,13 +70,13 @@
 
 #include "io_ops.h"
 
-/* only call once on startup, storage is global in BKE kernel listbase */
+/* Only called once on startup. storage is global in BKE kernel listbase. */
 void ED_spacetypes_init(void)
 {
-  /* UI_UNIT_X is now a variable, is used in some spacetype inits? */
+  /* UI unit is a variable, may be used in some space type inits. */
   U.widget_unit = 20;
 
-  /* create space types */
+  /* Create space types. */
   ED_spacetype_outliner();
   ED_spacetype_view3d();
   ED_spacetype_ipo();
@@ -95,9 +95,8 @@ void ED_spacetypes_init(void)
   ED_spacetype_clip();
   ED_spacetype_statusbar();
   ED_spacetype_topbar();
-  //  ...
 
-  /* register operator types for screen and all spaces */
+  /* Register operator types for screen and all spaces. */
   ED_operatortypes_userpref();
   ED_operatortypes_workspace();
   ED_operatortypes_scene();
@@ -129,7 +128,7 @@ void ED_spacetypes_init(void)
 
   ED_screen_user_menu_register();
 
-  /* gizmo types */
+  /* Gizmo types. */
   ED_gizmotypes_button_2d();
   ED_gizmotypes_dial_3d();
   ED_gizmotypes_move_3d();
@@ -141,10 +140,10 @@ void ED_spacetypes_init(void)
   ED_gizmotypes_cage_3d();
   ED_gizmotypes_snap_3d();
 
-  /* register types for operators and gizmos */
+  /* Register types for operators and gizmos. */
   const ListBase *spacetypes = BKE_spacetypes_list();
   LISTBASE_FOREACH (const SpaceType *, type, spacetypes) {
-    /* init gizmo types first, operator-types need them */
+    /* Initialize gizmo types first, operator types need them. */
     if (type->gizmos) {
       type->gizmos();
     }
@@ -156,8 +155,8 @@ void ED_spacetypes_init(void)
 
 void ED_spacemacros_init(void)
 {
-  /* Macros's must go last since they reference other operators.
-   * We need to have them go after python operators too */
+  /* Macros must go last since they reference other operators.
+   * They need to be registered after python operators too. */
   ED_operatormacros_armature();
   ED_operatormacros_mesh();
   ED_operatormacros_uvedit();
@@ -174,7 +173,7 @@ void ED_spacemacros_init(void)
   ED_operatormacros_paint();
   ED_operatormacros_gpencil();
 
-  /* register dropboxes (can use macros) */
+  /* Register dropboxes (can use macros). */
   const ListBase *spacetypes = BKE_spacetypes_list();
   LISTBASE_FOREACH (const SpaceType *, type, spacetypes) {
     if (type->dropboxes) {
@@ -183,9 +182,10 @@ void ED_spacemacros_init(void)
   }
 }
 
-/* called in wm.c */
-/* keymap definitions are registered only once per WM initialize, usually on file read,
- * using the keymap the actual areas/regions add the handlers */
+/**
+ * \note Keymap definitions are registered only once per WM initialize,
+ * usually on file read, using the keymap the actual areas/regions add the handlers.
+ * \note Called in wm.c. */
 void ED_spacetypes_keymap(wmKeyConfig *keyconf)
 {
   ED_keymap_screen(keyconf);
@@ -222,7 +222,7 @@ void ED_spacetypes_keymap(wmKeyConfig *keyconf)
   }
 }
 
-/* ********************** custom drawcall api ***************** */
+/* ********************** Custom Draw Call API ***************** */
 
 typedef struct RegionDrawCB {
   struct RegionDrawCB *next, *prev;