From 47d918ca35f8ae8ce4d24430e3520a06272f35f9 Mon Sep 17 00:00:00 2001 From: Simon Sapin Date: Thu, 14 Jan 2016 00:29:55 +0100 Subject: [PATCH] Document new return value of BlockFlow::assign_block_size_block_base --- components/layout/block.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/components/layout/block.rs b/components/layout/block.rs index 2ec619607a3..3774184fd6e 100644 --- a/components/layout/block.rs +++ b/components/layout/block.rs @@ -751,6 +751,14 @@ impl BlockFlow { /// For absolute flows, we store the calculated content block-size for the flow. We defer the /// calculation of the other values until a later traversal. /// + /// When `fragmentation_context` is given (not `None`), this should fit as much of the content + /// as possible within the available block size. + /// If there is more content (that doesn’t fit), this flow is *fragmented* + /// with the extra content moved to another fragment (a flow like this one) which is returrned. + /// See `Flow::fragment`. + /// + /// The return value is always `None` when `fragmentation_context` is `None`. + /// /// `inline(always)` because this is only ever called by in-order or non-in-order top-level /// methods. #[inline(always)]