[doc] rio-backend

Author: JRBros2346

rio-backend/src/ansi/mode.rs

@@ -118,7 +118,7 @@ pub enum NamedPrivateMode {
     UrgencyHints = 1042,
     SwapScreenAndSetRestoreCursor = 1049,
     BracketedPaste = 2004,
-    /// The mode is handled automatically by [`Processor`].
+    /// The mode is handled automatically by [`Processor`](crate::performer::handler::Processor).
     SyncUpdate = 2026,
 }
 

rio-backend/src/config/platform.rs

@@ -13,7 +13,7 @@ pub struct Platform {
 
 /// Other platform specific configuration options can be added here.
 ///
-/// When deserializing, each field is Option<T> to distinguish between
+/// When deserializing, each field is `Option<T>` to distinguish between
 /// "not specified" vs "specified with value". During merge, we recursively
 /// merge individual fields rather than replacing entire structures.
 #[derive(Default, Debug, Serialize, Deserialize, PartialEq, Clone)]

rio-backend/src/crosswords/grid/storage.rs

@@ -152,9 +152,9 @@ impl<T> Storage<T> {
         self.len == 0
     }
 
-    /// Swap implementation for Row<T>.
+    /// Swap implementation for `Row<T>`.
     ///
-    /// Exploits the known size of Row<T> to produce a slightly more efficient
+    /// Exploits the known size of `Row<T>` to produce a slightly more efficient
     /// swap than going through slice::swap.
     ///
     /// The default implementation from swap generates 8 movups and 4 movaps

rio-backend/src/crosswords/mod.rs

@@ -170,7 +170,7 @@ impl From<KeyboardModes> for Mode {
     }
 }
 
-/// Terminal damage information collected since the last [`Term::reset_damage`] call.
+/// Terminal damage information collected since the last [`Crosswords::reset_damage`] call.
 #[derive(Debug)]
 pub enum TermDamage<'a> {
     /// The entire terminal is damaged.

rio-backend/src/selection.rs

@@ -111,17 +111,17 @@ pub enum SelectionType {
 /// Describes a region of a 2-dimensional area.
 ///
 /// Used to track a text selection. There are four supported modes, each with its own constructor:
-/// [`simple`], [`block`], [`semantic`], and [`lines`]. The [`simple`] mode precisely tracks which
+/// [`simple`], [`block`], [`semantic`], and [`semantic`]. The [`simple`] mode precisely tracks which
 /// cells are selected without any expansion. [`block`] will select rectangular regions.
-/// [`lines`] will always select entire lines.
+/// [`semantic`] will always select entire lines.
 ///
 /// Calls to [`update`] operate different based on the selection kind. The [`simple`] and [`block`]
 /// mode do nothing special, simply track points and sides.
 ///
-/// [`simple`]: enum.Selection.html#method.simple
-/// [`block`]: enum.Selection.html#method.block
-/// [`lines`]: enum.Selection.html#method.rows
-/// [`update`]: enum.Selection.html#method.update
+/// [`simple`]: enum.SelectionType.html#variant.Simple
+/// [`block`]: enum.SelectionType.html#variant.Block
+/// [`semantic`]: enum.SelectionType.html#variant.Semantic
+/// [`update`]: enum.SelectionType.html#variant.Update
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Selection {
     pub ty: SelectionType,