Fix some broken doc links

This commit is contained in:
Emil Ernerfeldt 2022-05-23 17:25:31 +02:00
parent a5076d4cc4
commit f2dcdfc22c
7 changed files with 14 additions and 14 deletions

View file

@ -25,7 +25,7 @@ To use on Linux, first run:
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev
``` ```
You need to either use `edition = "2021"`, or set `resolver = "2"` in the `[workspace`] section of your to-level `Cargo.toml`. See [this link](https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html) for more info. You need to either use `edition = "2021"`, or set `resolver = "2"` in the `[workspace]` section of your to-level `Cargo.toml`. See [this link](https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html) for more info.
You can opt-in to the using [`egui_wgpu`](https://github.com/emilk/egui/tree/master/egui_wgpu) for rendering by enabling the `wgpu` feature and setting `NativeOptions::renderer` to `Renderer::Wgpu`. You can opt-in to the using [`egui_wgpu`](https://github.com/emilk/egui/tree/master/egui_wgpu) for rendering by enabling the `wgpu` feature and setting `NativeOptions::renderer` to `Renderer::Wgpu`.

View file

@ -475,7 +475,7 @@ pub struct Location {
/// ///
/// Note that the leading `?` is NOT included in the string. /// Note that the leading `?` is NOT included in the string.
/// ///
/// Use [`Self::web_query_map]` to get the parsed version of it. /// Use [`Self::query_map`] to get the parsed version of it.
pub query: String, pub query: String,
/// The parsed "query" part of "www.example.com/index.html?query#fragment". /// The parsed "query" part of "www.example.com/index.html?query#fragment".

View file

@ -21,14 +21,14 @@ pub enum TextStyle {
/// Normal labels. Easily readable, doesn't take up too much space. /// Normal labels. Easily readable, doesn't take up too much space.
Body, Body,
/// Same size as [`Self::Body]`, but used when monospace is important (for aligning number, code snippets, etc). /// Same size as [`Self::Body`], but used when monospace is important (for aligning number, code snippets, etc).
Monospace, Monospace,
/// Buttons. Maybe slightly bigger than [`Self::Body]`. /// Buttons. Maybe slightly bigger than [`Self::Body`].
/// Signifies that he item is interactive. /// Signifies that he item is interactive.
Button, Button,
/// Heading. Probably larger than [`Self::Body]`. /// Heading. Probably larger than [`Self::Body`].
Heading, Heading,
/// A user-chosen style, found in [`Style::text_styles`]. /// A user-chosen style, found in [`Style::text_styles`].

View file

@ -1952,7 +1952,7 @@ impl Ui {
/// ``` /// ```
/// ///
/// See also [`Self::allocate_ui_with_layout`], /// See also [`Self::allocate_ui_with_layout`],
/// and the helpers [`Self::horizontal]`, [`Self::vertical`], etc. /// and the helpers [`Self::horizontal`], [`Self::vertical`], etc.
#[inline] #[inline]
pub fn with_layout<R>( pub fn with_layout<R>(
&mut self, &mut self,

View file

@ -12,10 +12,10 @@ pub(crate) enum CellSize {
/// ///
/// In a strip there's only one line which goes in the direction of the strip: /// In a strip there's only one line which goes in the direction of the strip:
/// ///
/// In a horizontal strip, a `[StripLayout]` with horizontal `[CellDirection]` is used. /// In a horizontal strip, a [`StripLayout`] with horizontal [`CellDirection`] is used.
/// Its cells go from left to right inside this `[StripLayout]`. /// Its cells go from left to right inside this [`StripLayout`].
/// ///
/// In a table there's a `[StripLayout]` for each table row with a horizontal `[CellDirection]`. /// In a table there's a [`StripLayout`] for each table row with a horizontal [`CellDirection`].
/// Its cells go from left to right. And the lines go from top to bottom. /// Its cells go from left to right. And the lines go from top to bottom.
pub(crate) enum CellDirection { pub(crate) enum CellDirection {
/// Cells go from left to right. /// Cells go from left to right.
@ -24,7 +24,7 @@ pub(crate) enum CellDirection {
Vertical, Vertical,
} }
/// Positions cells in `[CellDirection]` and starts a new line on `[StripLayout::end_line]` /// Positions cells in [`CellDirection`] and starts a new line on [`StripLayout::end_line`]
pub struct StripLayout<'l> { pub struct StripLayout<'l> {
pub(crate) ui: &'l mut Ui, pub(crate) ui: &'l mut Ui,
direction: CellDirection, direction: CellDirection,

View file

@ -12,7 +12,7 @@ use egui::{Response, Ui};
/// In contrast to normal egui behavior, strip cells do *not* grow with its children! /// In contrast to normal egui behavior, strip cells do *not* grow with its children!
/// ///
/// First use [`Self::size`] and [`Self::sizes`] to allocate space for the rows or columns will follow. /// First use [`Self::size`] and [`Self::sizes`] to allocate space for the rows or columns will follow.
/// Then build the strip with `[Self::horizontal]`/`[Self::vertical]`, and add 'cells' /// Then build the strip with [`Self::horizontal`]/[`Self::vertical`], and add 'cells'
/// to it using [`Strip::cell`]. The number of cells MUST match the number of pre-allocated sizes. /// to it using [`Strip::cell`]. The number of cells MUST match the number of pre-allocated sizes.
/// ///
/// ### Example /// ### Example
@ -89,7 +89,7 @@ impl<'a> StripBuilder<'a> {
/// Build horizontal strip: Cells are positions from left to right. /// Build horizontal strip: Cells are positions from left to right.
/// Takes the available horizontal width, so there can't be anything right of the strip or the container will grow slowly! /// Takes the available horizontal width, so there can't be anything right of the strip or the container will grow slowly!
/// ///
/// Returns a `[egui::Response]` for hover events. /// Returns a [`egui::Response`] for hover events.
pub fn horizontal<F>(self, strip: F) -> Response pub fn horizontal<F>(self, strip: F) -> Response
where where
F: for<'b> FnOnce(Strip<'a, 'b>), F: for<'b> FnOnce(Strip<'a, 'b>),
@ -116,7 +116,7 @@ impl<'a> StripBuilder<'a> {
/// Build vertical strip: Cells are positions from top to bottom. /// Build vertical strip: Cells are positions from top to bottom.
/// Takes the full available vertical height, so there can't be anything below of the strip or the container will grow slowly! /// Takes the full available vertical height, so there can't be anything below of the strip or the container will grow slowly!
/// ///
/// Returns a `[egui::Response]` for hover events. /// Returns a [`egui::Response`] for hover events.
pub fn vertical<F>(self, strip: F) -> Response pub fn vertical<F>(self, strip: F) -> Response
where where
F: for<'b> FnOnce(Strip<'a, 'b>), F: for<'b> FnOnce(Strip<'a, 'b>),

View file

@ -394,7 +394,7 @@ impl<'a> TableBody<'a> {
/// Add a single row with the given height. /// Add a single row with the given height.
/// ///
/// If you have many thousands of row it can be more performant to instead use [`Self::rows]` or [`Self::heterogeneous_rows`]. /// If you have many thousands of row it can be more performant to instead use [`Self::rows`] or [`Self::heterogeneous_rows`].
pub fn row(&mut self, height: f32, row: impl FnOnce(TableRow<'a, '_>)) { pub fn row(&mut self, height: f32, row: impl FnOnce(TableRow<'a, '_>)) {
row(TableRow { row(TableRow {
layout: &mut self.layout, layout: &mut self.layout,