Fill out some more docs

This commit is contained in:
grovesNL 2023-01-29 22:29:17 -03:30
parent 983d6b7eac
commit a3e035881b
4 changed files with 7 additions and 2 deletions

View file

@ -52,6 +52,7 @@ impl Color {
} }
} }
/// An owned version of [`Family`]
#[derive(Clone, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub enum FamilyOwned { pub enum FamilyOwned {
Name(String), Name(String),
@ -177,6 +178,7 @@ impl<'a> Attrs<'a> {
} }
} }
/// An owned version of [`Attrs`]
#[derive(Clone, Debug, Eq, Hash, PartialEq)] #[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub struct AttrsOwned { pub struct AttrsOwned {
//TODO: should this be an option? //TODO: should this be an option?

View file

@ -40,6 +40,7 @@ impl Cursor {
} }
} }
/// Whether to associate cursors placed at a boundary between runs with the run before or after it.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)] #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
pub enum Affinity { pub enum Affinity {
Before, Before,
@ -78,6 +79,7 @@ impl Default for Affinity {
} }
} }
/// The position of a cursor within a [`Buffer`].
pub struct LayoutCursor { pub struct LayoutCursor {
pub line: usize, pub line: usize,
pub layout: usize, pub layout: usize,

View file

@ -10,6 +10,7 @@ mod matches;
pub use self::system::*; pub use self::system::*;
mod system; mod system;
/// A font
pub struct Font<'a> { pub struct Font<'a> {
pub info: &'a fontdb::FaceInfo, pub info: &'a fontdb::FaceInfo,
pub data: &'a [u8], pub data: &'a [u8],

View file

@ -56,7 +56,7 @@
// Not interested in these lints // Not interested in these lints
#![allow(clippy::new_without_default)] #![allow(clippy::new_without_default)]
// TODO: address ocurrances and then deny // TODO: address occurrences and then deny
// //
// Indexing a slice can cause panics and that is something we always want to avoid // Indexing a slice can cause panics and that is something we always want to avoid
#![allow(clippy::indexing_slicing)] #![allow(clippy::indexing_slicing)]
@ -64,7 +64,7 @@
#![allow(clippy::integer_arithmetic)] #![allow(clippy::integer_arithmetic)]
// Soundness issues // Soundness issues
// //
// Dereferencing unalinged pointers may be undefined behavior // Dereferencing unaligned pointers may be undefined behavior
#![deny(clippy::cast_ptr_alignment)] #![deny(clippy::cast_ptr_alignment)]
// Avoid panicking in without information about the panic. Use expect // Avoid panicking in without information about the panic. Use expect
#![deny(clippy::unwrap_used)] #![deny(clippy::unwrap_used)]