Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-04 13:10:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #29822 - mrobinson:rustdoc, r=mukilan

Browse source 
Convert some comments into rustdoc

These were always meant to be rustdoc and converting them makes them show up in the IDE in a more helpful way.

<!-- Please describe your changes on the following line: -->

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `___` with appropriate data: -->
- [x] `./mach build -d` does not report any errors
- [x] `./mach test-tidy` does not report any errors
- [x] These changes do not require tests because they do not change behavior.

<!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.-->

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->
This commit is contained in:
bors-servo 2023-06-01 09:18:49 +02:00 • committed by GitHub
commit 13e1aeb8cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

60
components/layout_2020/fragment_tree/containing_block.rs
View file

@ -10,40 +10,40 @@ use style::computed_values::position::T as ComputedPosition;
/// blocks (for all descendants, for absolute and fixed position /// blocks (for all descendants, for absolute and fixed position
/// descendants, and for fixed position descendants). /// descendants, and for fixed position descendants).
pub(crate) struct ContainingBlockManager<'a, T> { pub(crate) struct ContainingBlockManager<'a, T> {
// The containing block for all non-absolute descendants. "...if the element's /// The containing block for all non-absolute descendants. "...if the element's
// position is 'relative' or 'static', the containing block is formed by the /// position is 'relative' or 'static', the containing block is formed by the
// content edge of the nearest block container ancestor box." This is also /// content edge of the nearest block container ancestor box." This is also
// the case for 'position: sticky' elements. /// the case for 'position: sticky' elements.
// https://www.w3.org/TR/CSS2/visudet.html#containing-block-details /// https://www.w3.org/TR/CSS2/visudet.html#containing-block-details
pub for_non_absolute_descendants: &'a T, pub for_non_absolute_descendants: &'a T,
// The containing block for absolute descendants. "If the element has /// The containing block for absolute descendants. "If the element has
// 'position: absolute', the containing block is /// 'position: absolute', the containing block is
// established by the nearest ancestor with a 'position' of 'absolute', /// established by the nearest ancestor with a 'position' of 'absolute',
// 'relative' or 'fixed', in the following way: /// 'relative' or 'fixed', in the following way:
// 1. In the case that the ancestor is an inline element, the containing /// 1. In the case that the ancestor is an inline element, the containing
// block is the bounding box around the padding boxes of the first and the /// block is the bounding box around the padding boxes of the first and the
// last inline boxes generated for that element. In CSS 2.1, if the inline /// last inline boxes generated for that element. In CSS 2.1, if the inline
// element is split across multiple lines, the containing block is /// element is split across multiple lines, the containing block is
// undefined. /// undefined.
// 2. Otherwise, the containing block is formed by the padding edge of the /// 2. Otherwise, the containing block is formed by the padding edge of the
// ancestor." /// ancestor."
// https://www.w3.org/TR/CSS2/visudet.html#containing-block-details /// https://www.w3.org/TR/CSS2/visudet.html#containing-block-details
// If the ancestor forms a containing block for all descendants (see below), /// If the ancestor forms a containing block for all descendants (see below),
// this value will be None and absolute descendants will use the containing /// this value will be None and absolute descendants will use the containing
// block for fixed descendants. /// block for fixed descendants.
pub for_absolute_descendants: Option<&'a T>, pub for_absolute_descendants: Option<&'a T>,
// The containing block for fixed and absolute descendants. /// The containing block for fixed and absolute descendants.
// "For elements whose layout is governed by the CSS box model, any value /// "For elements whose layout is governed by the CSS box model, any value
// other than none for the transform property also causes the element to /// other than none for the transform property also causes the element to
// establish a containing block for all descendants. Its padding box will be /// establish a containing block for all descendants. Its padding box will be
// used to layout for all of its absolute-position descendants, /// used to layout for all of its absolute-position descendants,
// fixed-position descendants, and descendant fixed background attachments." /// fixed-position descendants, and descendant fixed background attachments."
// https://w3c.github.io/csswg-drafts/css-transforms-1/#containing-block-for-all-descendants /// https://w3c.github.io/csswg-drafts/css-transforms-1/#containing-block-for-all-descendants
// See `ComputedValues::establishes_containing_block_for_all_descendants` /// See `ComputedValues::establishes_containing_block_for_all_descendants`
// for a list of conditions where an element forms a containing block for /// for a list of conditions where an element forms a containing block for
// all descendants. /// all descendants.
pub for_absolute_and_fixed_descendants: &'a T, pub for_absolute_and_fixed_descendants: &'a T,
} }