Cleanup: improve comments
authorCampbell Barton <ideasman42@gmail.com>
Sun, 4 Aug 2019 02:52:01 +0000 (12:52 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Sun, 4 Aug 2019 02:53:06 +0000 (12:53 +1000)
source/blender/editors/interface/interface_templates.c
source/blender/editors/space_view3d/view3d_edit.c

index 654483c2182e56ce8da89587c5fe9059611b36e3..fb8c2f597485cb939bc19aaa70b2fe793d493c9a 100644 (file)
@@ -4064,8 +4064,11 @@ static void curvemap_buttons_reset(bContext *C, void *cb_v, void *cumap_v)
   rna_update_cb(C, cb_v, NULL);
 }
 
-/* still unsure how this call evolves...
- * we use labeltype for defining what curve-channels to show */
+/**
+ * \note Still unsure how this call evolves.
+ *
+ * \param labeltype: Used for defining which curve-channels to show.
+ */
 static void curvemap_buttons_layout(uiLayout *layout,
                                     PointerRNA *ptr,
                                     char labeltype,
index 62673d9bd5a8b8f33aa7c5672f645e05ff916d35..ff0052c1fd103f6093c7023afdb163a0d4d51384 100644 (file)
@@ -183,6 +183,10 @@ typedef struct ViewOpsData {
   bool use_dyn_ofs;
 } ViewOpsData;
 
+/**
+ * Size of the sphere being dragged for trackball rotation withing the view bounds.
+ * also affects speed (smaller is faster).
+ */
 #define TRACKBALLSIZE (1.1f)
 
 static void calctrackballvec(const rcti *rect, const int event_xy[2], float r_dir[3])
@@ -190,8 +194,8 @@ static void calctrackballvec(const rcti *rect, const int event_xy[2], float r_di
   const float radius = TRACKBALLSIZE;
   const float t = radius / (float)M_SQRT2;
   const float size[2] = {BLI_rcti_size_x(rect), BLI_rcti_size_y(rect)};
-  /* Aspect correct so dragging in a non-square view doesn't squash the,
-   * so diagonal motion rotates diagonally too. */
+  /* Aspect correct so dragging in a non-square view doesn't squash the direction.
+   * So diagonal motion rotates the same direction the cursor is moving. */
   const float size_min = min_ff(size[0], size[1]);
   const float aspect[2] = {size_min / size[0], size_min / size[1]};