Fix broken intra-doc links to Sandbox

This commit is contained in:
Héctor Ramón Jiménez 2024-03-17 13:55:15 +01:00
parent 846d76cd3f
commit 179e8863b3
No known key found for this signature in database
GPG key ID: 7CC46565708259A7
4 changed files with 15 additions and 13 deletions

View file

@ -15,9 +15,7 @@ pub use application::{default, Appearance, DefaultStyle};
/// document. /// document.
/// ///
/// An [`Application`] can execute asynchronous actions by returning a /// An [`Application`] can execute asynchronous actions by returning a
/// [`Command`] in some of its methods. If you do not intend to perform any /// [`Command`] in some of its methods.
/// background work in your program, the [`Sandbox`] trait offers a simplified
/// interface.
/// ///
/// When using an [`Application`] with the `debug` feature enabled, a debug view /// When using an [`Application`] with the `debug` feature enabled, a debug view
/// can be toggled by pressing `F12`. /// can be toggled by pressing `F12`.

View file

@ -134,8 +134,15 @@
//! } //! }
//! ``` //! ```
//! //!
//! And that's everything! We just wrote a whole user interface. Iced is now //! And that's everything! We just wrote a whole user interface. Let's run it:
//! able to: //!
//! ```no_run
//! fn main() -> iced::Result {
//! iced::run("A cool counter", Counter::update, Counter::view)
//! }
//! ```
//!
//! Iced will automatically:
//! //!
//! 1. Take the result of our __view logic__ and layout its widgets. //! 1. Take the result of our __view logic__ and layout its widgets.
//! 1. Process events from our system and produce __messages__ for our //! 1. Process events from our system and produce __messages__ for our
@ -143,11 +150,12 @@
//! 1. Draw the resulting user interface. //! 1. Draw the resulting user interface.
//! //!
//! # Usage //! # Usage
//! The [`Application`] and [`Sandbox`] traits should get you started quickly, //! You can either use the [`application`] builder or implement the [`Application`]
//! streamlining all the process described above! //! trait directly.
//! //!
//! [Elm]: https://elm-lang.org/ //! [Elm]: https://elm-lang.org/
//! [The Elm Architecture]: https://guide.elm-lang.org/architecture/ //! [The Elm Architecture]: https://guide.elm-lang.org/architecture/
//! [`application`]: application()
#![doc( #![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg" html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)] )]

View file

@ -14,9 +14,7 @@ pub use crate::application::{Appearance, DefaultStyle};
/// document and display only the contents of the `window::Id::MAIN` window. /// document and display only the contents of the `window::Id::MAIN` window.
/// ///
/// An [`Application`] can execute asynchronous actions by returning a /// An [`Application`] can execute asynchronous actions by returning a
/// [`Command`] in some of its methods. If you do not intend to perform any /// [`Command`] in some of its methods.
/// background work in your program, the [`Sandbox`] trait offers a simplified
/// interface.
/// ///
/// When using an [`Application`] with the `debug` feature enabled, a debug view /// When using an [`Application`] with the `debug` feature enabled, a debug view
/// can be toggled by pressing `F12`. /// can be toggled by pressing `F12`.

View file

@ -5,7 +5,7 @@
//! or a specific type. //! or a specific type.
//! //!
//! This API is meant to be a more convenient—although less //! This API is meant to be a more convenient—although less
//! powerful—alternative to the [`Sandbox`] and [`Application`] traits. //! powerful—alternative to the [`Application`] traits.
//! //!
//! [`Sandbox`]: crate::Sandbox //! [`Sandbox`]: crate::Sandbox
//! //!
@ -748,8 +748,6 @@ fn with_style<P: Definition>(
/// ///
/// This trait is implemented both for `&static str` and /// This trait is implemented both for `&static str` and
/// any closure `Fn(&State) -> String`. /// any closure `Fn(&State) -> String`.
///
/// You can use any of these in [`Program::title`].
pub trait Title<State> { pub trait Title<State> {
/// Produces the title of the [`Program`]. /// Produces the title of the [`Program`].
fn title(&self, state: &State) -> String; fn title(&self, state: &State) -> String;