summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-04-01 04:34:14 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-04-02 03:44:14 +0200
commit4c44517556976454c0598c876addb10b88515cda (patch)
treebf86a945d28f206ca932082daf5ef61cd783b27b
parentf4f8f62f55bcaf5b92b7af96544f153f88bab287 (diff)
downloadiced-4c44517556976454c0598c876addb10b88515cda.tar.gz
iced-4c44517556976454c0598c876addb10b88515cda.tar.bz2
iced-4c44517556976454c0598c876addb10b88515cda.zip
Fix minor documentation issues
-rw-r--r--native/src/widget/pane_grid.rs13
-rw-r--r--src/widget.rs4
-rw-r--r--wgpu/src/widget/canvas.rs2
-rw-r--r--wgpu/src/widget/canvas/layer/cache.rs2
-rw-r--r--wgpu/src/widget/canvas/path.rs1
5 files changed, 14 insertions, 8 deletions
diff --git a/native/src/widget/pane_grid.rs b/native/src/widget/pane_grid.rs
index 2eca68d3..ccb46571 100644
--- a/native/src/widget/pane_grid.rs
+++ b/native/src/widget/pane_grid.rs
@@ -59,12 +59,13 @@ use crate::{
///
/// let (mut state, _) = pane_grid::State::new(PaneState::SomePane);
///
-/// let pane_grid = PaneGrid::new(&mut state, |pane, state, focus| {
-/// match state {
-/// PaneState::SomePane => Text::new("This is some pane"),
-/// PaneState::AnotherKindOfPane => Text::new("This is another kind of pane"),
-/// }.into()
-/// })
+/// let pane_grid =
+/// PaneGrid::new(&mut state, |pane, state, focus| {
+/// match state {
+/// PaneState::SomePane => Text::new("This is some pane"),
+/// PaneState::AnotherKindOfPane => Text::new("This is another kind of pane"),
+/// }.into()
+/// })
/// .on_drag(Message::PaneDragged)
/// .on_resize(Message::PaneResized);
/// ```
diff --git a/src/widget.rs b/src/widget.rs
index d8317091..758dc930 100644
--- a/src/widget.rs
+++ b/src/widget.rs
@@ -40,6 +40,10 @@ mod platform {
text_input::TextInput,
};
+ #[cfg(feature = "canvas")]
+ #[doc(no_inline)]
+ pub use canvas::Canvas;
+
/// A container that distributes its contents vertically.
///
/// This is an alias of an `iced_native` column with a default `Renderer`.
diff --git a/wgpu/src/widget/canvas.rs b/wgpu/src/widget/canvas.rs
index 5d531a0a..6c9a9e19 100644
--- a/wgpu/src/widget/canvas.rs
+++ b/wgpu/src/widget/canvas.rs
@@ -42,7 +42,7 @@ pub use text::Text;
/// # Example
/// Let's see how we can draw a circle:
///
-/// ```
+/// ```no_run
/// # mod iced {
/// # pub use iced_wgpu::canvas;
/// # pub use iced_native::Color;
diff --git a/wgpu/src/widget/canvas/layer/cache.rs b/wgpu/src/widget/canvas/layer/cache.rs
index f7002459..20a095bd 100644
--- a/wgpu/src/widget/canvas/layer/cache.rs
+++ b/wgpu/src/widget/canvas/layer/cache.rs
@@ -12,7 +12,7 @@ use std::{cell::RefCell, marker::PhantomData, sync::Arc};
/// change or it is explicitly cleared.
///
/// [`Layer`]: ../trait.Layer.html
-/// [`Cached`]: struct.Cached.html
+/// [`Cache`]: struct.Cache.html
#[derive(Debug)]
pub struct Cache<T: Drawable> {
input: PhantomData<T>,
diff --git a/wgpu/src/widget/canvas/path.rs b/wgpu/src/widget/canvas/path.rs
index 15c2e853..e7ff47f3 100644
--- a/wgpu/src/widget/canvas/path.rs
+++ b/wgpu/src/widget/canvas/path.rs
@@ -3,6 +3,7 @@ pub mod arc;
mod builder;
+#[doc(no_inline)]
pub use arc::Arc;
pub use builder::Builder;