diff options
Diffstat (limited to 'library/src/layout')
| -rw-r--r-- | library/src/layout/align.rs | 1 | ||||
| -rw-r--r-- | library/src/layout/columns.rs | 1 | ||||
| -rw-r--r-- | library/src/layout/container.rs | 5 | ||||
| -rw-r--r-- | library/src/layout/grid.rs | 5 | ||||
| -rw-r--r-- | library/src/layout/pad.rs | 7 | ||||
| -rw-r--r-- | library/src/layout/page.rs | 1 | ||||
| -rw-r--r-- | library/src/layout/place.rs | 3 | ||||
| -rw-r--r-- | library/src/layout/spacing.rs | 2 | ||||
| -rw-r--r-- | library/src/layout/stack.rs | 2 | ||||
| -rw-r--r-- | library/src/layout/transform.rs | 5 |
10 files changed, 32 insertions, 0 deletions
diff --git a/library/src/layout/align.rs b/library/src/layout/align.rs index 7853d84d..5426f5e2 100644 --- a/library/src/layout/align.rs +++ b/library/src/layout/align.rs @@ -5,6 +5,7 @@ use crate::prelude::*; /// # Parameters /// - body: Content (positional, required) /// The content to align. +/// /// - alignment: Axes<Option<GenAlign>> (positional, settable) /// The alignment along both axes. /// diff --git a/library/src/layout/columns.rs b/library/src/layout/columns.rs index b31b0a6d..6154cd14 100644 --- a/library/src/layout/columns.rs +++ b/library/src/layout/columns.rs @@ -6,6 +6,7 @@ use crate::text::TextNode; /// # Parameters /// - count: usize (positional, required) /// The number of columns. +/// /// - body: Content (positional, required) /// The content that should be layouted into the columns. /// diff --git a/library/src/layout/container.rs b/library/src/layout/container.rs index 4b58434b..5df6b2dc 100644 --- a/library/src/layout/container.rs +++ b/library/src/layout/container.rs @@ -7,8 +7,10 @@ use crate::prelude::*; /// # Parameters /// - body: Content (positional) /// The contents of the box. +/// /// - width: Rel<Length> (named) /// The width of the box. +/// /// - height: Rel<Length> (named) /// The height of the box. /// @@ -78,11 +80,14 @@ impl Inline for BoxNode {} /// # Parameters /// - body: Content (positional) /// The contents of the block. +/// /// - spacing: Spacing (named, settable) /// The spacing around this block. +/// /// - above: Spacing (named, settable) /// The spacing between the previous and this block. Takes precedence over /// `spacing`. +/// /// - below: Spacing (named, settable) /// The spacing between this block and the following one. Takes precedence /// over `spacing`. diff --git a/library/src/layout/grid.rs b/library/src/layout/grid.rs index 8aaffe08..1cf95001 100644 --- a/library/src/layout/grid.rs +++ b/library/src/layout/grid.rs @@ -7,14 +7,19 @@ use super::Spacing; /// # Parameters /// - cells: Content (positional, variadic) /// The contents of the table cells. +/// /// - rows: TrackSizings (named) /// Defines the row sizes. +/// /// - columns: TrackSizings (named) /// Defines the column sizes. +/// /// - gutter: TrackSizings (named) /// Defines the gaps between rows & columns. +/// /// - column-gutter: TrackSizings (named) /// Defines the gaps between columns. Takes precedence over `gutter`. +/// /// - row-gutter: TrackSizings (named) /// Defines the gaps between rows. Takes precedence over `gutter`. /// diff --git a/library/src/layout/pad.rs b/library/src/layout/pad.rs index 94492f83..1326ae22 100644 --- a/library/src/layout/pad.rs +++ b/library/src/layout/pad.rs @@ -5,18 +5,25 @@ use crate::prelude::*; /// # Parameters /// - body: Content (positional, required) /// The content to pad at the sides. +/// /// - left: Rel<Length> (named) /// The padding at the left side. +/// /// - right: Rel<Length> (named) /// The padding at the right side. +/// /// - top: Rel<Length> (named) /// The padding at the top side. +/// /// - bottom: Rel<Length> (named) /// The padding at the bottom side. +/// /// - x: Rel<Length> (named) /// The horizontal padding. Both `left` and `right` take precedence over this. +/// /// - y: Rel<Length> (named) /// The vertical padding. Both `top` and `bottom` take precedence over this. +/// /// - rest: Rel<Length> (named) /// The padding for all sides. All other parameters take precedence over this. /// diff --git a/library/src/layout/page.rs b/library/src/layout/page.rs index 8782ed08..a2548c02 100644 --- a/library/src/layout/page.rs +++ b/library/src/layout/page.rs @@ -9,6 +9,7 @@ use crate::text::TextNode; /// # Parameters /// - body: Content (positional, required) /// The contents of the page(s). +/// /// - paper: Paper (positional, settable) /// The paper size. /// diff --git a/library/src/layout/place.rs b/library/src/layout/place.rs index 890480a7..8baf69af 100644 --- a/library/src/layout/place.rs +++ b/library/src/layout/place.rs @@ -5,10 +5,13 @@ use crate::prelude::*; /// # Parameters /// - alignment: Axes<Option<GenAlign>> (positional) /// Relative to which position in the parent container to place the content. +/// /// - body: Content (positional, required) /// The content to place. +/// /// - dx: Rel<Length> (named) /// The horizontal displacement of the placed content. +/// /// - dy: Rel<Length> (named) /// The vertical displacement of the placed content. /// diff --git a/library/src/layout/spacing.rs b/library/src/layout/spacing.rs index ef69c070..092d2c0a 100644 --- a/library/src/layout/spacing.rs +++ b/library/src/layout/spacing.rs @@ -7,6 +7,7 @@ use crate::prelude::*; /// # Parameters /// - amount: Spacing (positional, required) /// How much spacing to insert. +/// /// - weak: bool (named) /// If true, the spacing collapses at the start or end of a paragraph. /// Moreover, from multiple adjacent weak spacings all but the largest one @@ -67,6 +68,7 @@ impl Behave for HNode { /// # Parameters /// - amount: Spacing (positional, required) /// How much spacing to insert. +/// /// - weak: bool (named) /// If true, the spacing collapses at the start or end of a flow. /// Moreover, from multiple adjacent weak spacings all but the largest one diff --git a/library/src/layout/stack.rs b/library/src/layout/stack.rs index deb565b6..2683175a 100644 --- a/library/src/layout/stack.rs +++ b/library/src/layout/stack.rs @@ -8,8 +8,10 @@ use crate::prelude::*; /// # Parameters /// - items: StackChild (positional, variadic) /// The items to stack along an axis. +/// /// - dir: Dir (named) /// The direction along which the items are stacked. +/// /// - spacing: Spacing (named) /// Spacing to insert between items where no explicit spacing was provided. /// diff --git a/library/src/layout/transform.rs b/library/src/layout/transform.rs index 3af44ca0..b509607d 100644 --- a/library/src/layout/transform.rs +++ b/library/src/layout/transform.rs @@ -7,8 +7,10 @@ use crate::prelude::*; /// # Parameters /// - body: Content (positional, required) /// The content to move. +/// /// - dx: Rel<Length> (named) /// The horizontal displacement of the content. +/// /// - dy: Rel<Length> (named) /// The vertical displacement of the content. /// @@ -61,10 +63,13 @@ impl Inline for MoveNode {} /// # Parameters /// - body: Content (positional, required) /// The content to transform. +/// /// - angle: Angle (named) /// The amount of rotation. +/// /// - x: Ratio (named) /// The horizontal scaling factor. +/// /// - y: Ratio (named) /// The vertical scaling factor. /// |
