migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-08-30 13:20:05 -04:00
Code Activity

Add more doc-links in docstrings (#1419)

Browse Source
This commit is contained in:
4JX
2022-04-03 18:18:35 +02:00
committed by GitHub
parent 861b0e11ba
commit 6091370962
60 changed files with 257 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
epaint/src/text/font.rs
View File

@@ -212,7 +212,7 @@ impl FontImpl {
type FontIndex = usize;
// TODO: rename?
/// Wrapper over multiple `FontImpl` (e.g. a primary + fallbacks for emojis)
/// Wrapper over multiple [`FontImpl`] (e.g. a primary + fallbacks for emojis)
pub struct Font {
fonts: Vec<Arc<FontImpl>>,
/// Lazily calculated.

2
epaint/src/text/fonts.rs
View File

@@ -658,7 +658,7 @@ struct FontImplCache {
pixels_per_point: f32,
ab_glyph_fonts: BTreeMap<String, (FontTweak, ab_glyph::FontArc)>,
/// Map font pixel sizes and names to the cached `FontImpl`.
/// Map font pixel sizes and names to the cached [`FontImpl`].
cache: ahash::AHashMap<(u32, String), Arc<FontImpl>>,
}

18
epaint/src/text/text_layout_types.rs
View File

@@ -37,12 +37,12 @@ use emath::*;
/// );
/// ```
///
/// As you can see, constructing a `LayoutJob` is currently a lot of work.
/// As you can see, constructing a [`LayoutJob`] is currently a lot of work.
/// It would be nice to have a helper macro for it!
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct LayoutJob {
/// The complete text of this job, referenced by `LayoutSection`.
/// The complete text of this job, referenced by [`LayoutSection`].
pub text: String,
/// The different section, which can have different fonts, colors, etc.
@@ -140,7 +140,7 @@ impl LayoutJob {
self.sections.is_empty()
}
/// Helper for adding a new section when building a `LayoutJob`.
/// Helper for adding a new section when building a [`LayoutJob`].
pub fn append(&mut self, text: &str, leading_space: f32, format: TextFormat) {
let start = self.text.len();
self.text += text;
@@ -308,11 +308,11 @@ pub struct Row {
/// The mesh, ready to be rendered.
pub visuals: RowVisuals,
/// If true, this `Row` came from a paragraph ending with a `\n`.
/// If true, this [`Row`] came from a paragraph ending with a `\n`.
/// The `\n` itself is omitted from [`Self::glyphs`].
/// A `\n` in the input text always creates a new `Row` below it,
/// so that text that ends with `\n` has an empty `Row` last.
/// This also implies that the last `Row` in a `Galley` always has `ends_with_newline == false`.
/// A `\n` in the input text always creates a new [`Row`] below it,
/// so that text that ends with `\n` has an empty [`Row`] last.
/// This also implies that the last [`Row`] in a [`Galley`] always has `ends_with_newline == false`.
pub ends_with_newline: bool,
}
@@ -373,13 +373,13 @@ impl Glyph {
// ----------------------------------------------------------------------------
impl Row {
/// Excludes the implicit `\n` after the `Row`, if any.
/// Excludes the implicit `\n` after the [`Row`], if any.
#[inline]
pub fn char_count_excluding_newline(&self) -> usize {
self.glyphs.len()
}
/// Includes the implicit `\n` after the `Row`, if any.
/// Includes the implicit `\n` after the [`Row`], if any.
#[inline]
pub fn char_count_including_newline(&self) -> usize {
self.glyphs.len() + (self.ends_with_newline as usize)