Bug 1494694: Improve a comment in the ComputedFlexItemInfo structure header. r=dholbert
authorBrad Werth <bwerth@mozilla.com>
Mon, 01 Oct 2018 16:08:00 +0000
changeset 494715 72d5f7a7f6eccc258f0779915c25d464784215d7
parent 494714 a01ecf3d6f9fa5bd46f662c811f6a92acc147902
child 494716 34a28e399019ae29cd14162dfde0b5bd581a5327
child 494753 ba7f9ff7e4c528f35042ca72cc345353d655e560
push id9984
push userffxbld-merge
push dateMon, 15 Oct 2018 21:07:35 +0000
treeherdermozilla-beta@183d27ea8570 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersdholbert
bugs1494694
milestone64.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1494694: Improve a comment in the ComputedFlexItemInfo structure header. r=dholbert Differential Revision: https://phabricator.services.mozilla.com/D7115
layout/generic/nsFlexContainerFrame.h
--- a/layout/generic/nsFlexContainerFrame.h
+++ b/layout/generic/nsFlexContainerFrame.h
@@ -35,19 +35,21 @@ struct ComputedFlexItemInfo
   /**
    * mMainBaseSize is a measure of the size of the item in the main
    * axis before the flex sizing algorithm is applied. In the spec,
    * this is called "flex base size", but we use this name to connect
    * the value to the other main axis sizes.
    */
   nscoord mMainBaseSize;
   /**
-   * mMainDeltaSize is the value that the flex sizing algorithm
-   * "wants" to use to stretch or shrink the item, before clamping to
-   * the item's main min and max sizes. Since the flex sizing
+   * mMainDeltaSize is the amount that the flex sizing algorithm
+   * adds to the mMainBaseSize, before clamping to mMainMinSize and
+   * mMainMaxSize. This can be thought of as the amount by which the
+   * flex layout algorithm "wants" to shrink or grow the item, and
+   * would do, if it was unconstrained. Since the flex sizing
    * algorithm proceeds linearly, the mMainDeltaSize for an item only
    * respects the resolved size of items already frozen.
    */
   nscoord mMainDeltaSize;
   nscoord mMainMinSize;
   nscoord mMainMaxSize;
   nscoord mCrossMinSize;
   nscoord mCrossMaxSize;