Bug 1037177 part 5: Update documentation for GenerateFlexItemForChild & helpers. (comment-only, no review)

This commit is contained in:
Daniel Holbert 2014-07-22 08:24:36 -07:00
parent fd1ff0cc24
commit 17b1051d8a

View File

@ -106,18 +106,38 @@ protected:
void SanityCheckAnonymousFlexItems() const;
#endif // DEBUG
// Returns a new FlexItem for the given child frame, allocated on the heap.
// Caller is responsible for managing the FlexItem's lifetime.
/*
* Returns a new FlexItem for the given child frame, allocated on the heap.
* Guaranteed to return non-null. Caller is responsible for managing the
* FlexItem's lifetime.
*
* Before returning, this method also processes the FlexItem to resolve its
* flex basis (including e.g. auto-height) as well as to resolve
* "min-height:auto", via ResolveAutoFlexBasisAndMinSize(). (Basically, the
* returned FlexItem will be ready to participate in the "Resolve the
* Flexible Lengths" step of the Flex Layout Algorithm.)
*/
FlexItem* GenerateFlexItemForChild(nsPresContext* aPresContext,
nsIFrame* aChildFrame,
const nsHTMLReflowState& aParentReflowState,
const FlexboxAxisTracker& aAxisTracker);
/**
* This method performs a "measuring" reflow to get the content height of
* aFlexItem.Frame() (treating it as if it had auto-height), & returns the
* resulting height.
* (Helper for ResolveAutoFlexBasisAndMinSize().)
*/
nscoord MeasureFlexItemContentHeight(nsPresContext* aPresContext,
FlexItem& aFlexItem,
bool aForceVerticalResizeForMeasuringReflow,
const nsHTMLReflowState& aParentReflowState);
/**
* This method resolves an "auto" flex-basis and/or min-main-size value
* on aFlexItem, if needed.
* (Helper for GenerateFlexItemForChild().)
*/
void ResolveAutoFlexBasisAndMinSize(nsPresContext* aPresContext,
FlexItem& aFlexItem,
const nsHTMLReflowState& aParentReflowState,