reivilibre/iced-mobile
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix minor documentation issues in pane_grid

Browse Source
This commit is contained in:
Héctor Ramón Jiménez 2020-03-19 09:43:36 +01:00
parent bb898fa2e2
commit 420275793e
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
native/src/widget/pane_grid.rs
View File

@ -93,6 +93,7 @@ impl<'a, Message, Renderer> PaneGrid<'a, Message, Renderer> {
/// ///
/// [`PaneGrid`]: struct.PaneGrid.html /// [`PaneGrid`]: struct.PaneGrid.html
/// [`State`]: struct.State.html /// [`State`]: struct.State.html
/// [`Pane`]: struct.Pane.html
pub fn new<T>( pub fn new<T>(
state: &'a mut State<T>, state: &'a mut State<T>,
view: impl Fn( view: impl Fn(
@ -219,7 +220,7 @@ impl<'a, Message, Renderer> PaneGrid<'a, Message, Renderer> {
/// If the function returns `None`, the key press event will be discarded /// If the function returns `None`, the key press event will be discarded
/// without producing any message. /// without producing any message.
/// ///
/// This function is particularly useful to implement hotkey interactions. /// This method is particularly useful to implement hotkey interactions.
/// For instance, you can use it to enable splitting, swapping, or resizing /// For instance, you can use it to enable splitting, swapping, or resizing
/// panes by pressing combinations of keys. /// panes by pressing combinations of keys.
/// ///
@ -319,12 +320,16 @@ pub enum DragEvent {
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub struct ResizeEvent { pub struct ResizeEvent {
/// The [`Split`] that is being dragged for resizing. /// The [`Split`] that is being dragged for resizing.
///
/// [`Split`]: struct.Split.html
pub split: Split, pub split: Split,
/// The new ratio of the [`Split`]. /// The new ratio of the [`Split`].
/// ///
/// The ratio is a value in [0, 1], representing the exact position of a /// The ratio is a value in [0, 1], representing the exact position of a
/// [`Split`] between two panes. /// [`Split`] between two panes.
///
/// [`Split`]: struct.Split.html
pub ratio: f32, pub ratio: f32,
} }

5
native/src/widget/pane_grid/state.rs
View File

@ -18,8 +18,9 @@ use std::collections::HashMap;
/// ///
/// [`PaneGrid`]: struct.PaneGrid.html /// [`PaneGrid`]: struct.PaneGrid.html
/// [`PaneGrid::new`]: struct.PaneGrid.html#method.new /// [`PaneGrid::new`]: struct.PaneGrid.html#method.new
/// [`State`]: struct.State.html
/// [`Pane`]: struct.Pane.html /// [`Pane`]: struct.Pane.html
/// [`Split`]: struct.Split.html
/// [`State`]: struct.State.html
#[derive(Debug)] #[derive(Debug)]
pub struct State<T> { pub struct State<T> {
pub(super) panes: HashMap<Pane, T>, pub(super) panes: HashMap<Pane, T>,
@ -28,6 +29,8 @@ pub struct State<T> {
} }
/// The current focus of a [`Pane`]. /// The current focus of a [`Pane`].
///
/// [`Pane`]: struct.Pane.html
#[derive(Debug, Clone, Copy, PartialEq, Eq)] #[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Focus { pub enum Focus {
/// The [`Pane`] is just focused. /// The [`Pane`] is just focused.