mirror of
https://codeberg.org/waydeer/layer-shika.git
synced 2025-12-12 14:25:54 +00:00
docs: add docs for anchor edges
This commit is contained in:
parent
d38ae99833
commit
65b3d092f9
1 changed files with 10 additions and 0 deletions
|
|
@ -1,3 +1,13 @@
|
||||||
|
/// Represents which edges of the output a layer surface should be anchored to.
|
||||||
|
///
|
||||||
|
/// Use predefined helpers like `top_bar()`, `bottom_bar()`, or build custom configurations
|
||||||
|
/// with `empty()` combined with `with_top()`, `with_bottom()`, `with_left()`, `with_right()`.
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
/// ```
|
||||||
|
/// let top_bar = AnchorEdges::top_bar();
|
||||||
|
/// let custom = AnchorEdges::empty().with_top().with_left();
|
||||||
|
/// ```
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
pub struct AnchorEdges(u8);
|
pub struct AnchorEdges(u8);
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue