瀏覽代碼

fix doc links

Evan Almloff 2 年之前
父節點
當前提交
ed0184685d

+ 3 - 3
packages/router/src/components/history_buttons.rs

@@ -3,7 +3,7 @@ use log::error;
 
 use crate::{prelude::*, utils::use_router_internal::use_router_internal};
 
-/// The properties for a [`GoBackButton`] or a [`GoForwardButton`].
+/// The properties for a [`GenericGoBackButton`] or a [`GenericGoForwardButton`].
 #[derive(Debug, Props)]
 pub struct GenericHistoryButtonProps<'a> {
     /// The children to render within the generated HTML button tag.
@@ -17,7 +17,7 @@ pub struct GenericHistoryButtonProps<'a> {
 /// The button will disable itself if it is known that no prior history is available.
 ///
 /// # Panic
-/// - When the [`GoBackButton`] is not nested within a [`GenericRouter`] component
+/// - When the [`GenericGoBackButton`] is not nested within a [`GenericRouter`] component
 ///   hook, but only in debug builds.
 ///
 /// # Example
@@ -91,7 +91,7 @@ pub fn GenericGoBackButton<'a, R: Routable>(
 /// The button will disable itself if it is known that no later history is available.
 ///
 /// # Panic
-/// - When the [`GoForwardButton`] is not nested within a [`GenericRouter`] component
+/// - When the [`GenericGoForwardButton`] is not nested within a [`GenericRouter`] component
 ///   hook, but only in debug builds.
 ///
 /// # Example

+ 2 - 2
packages/router/src/components/link.rs

@@ -7,7 +7,7 @@ use crate::navigation::NavigationTarget;
 use crate::prelude::*;
 use crate::utils::use_router_internal::use_router_internal;
 
-/// The properties for a [`Link`].
+/// The properties for a [`GenericLink`].
 #[derive(Props)]
 pub struct GenericLinkProps<'a, R: Routable> {
     /// A class to apply to the generate HTML anchor tag if the `target` route is active.
@@ -23,7 +23,7 @@ pub struct GenericLinkProps<'a, R: Routable> {
     pub id: Option<&'a str>,
     /// When [`true`], the `target` route will be opened in a new tab.
     ///
-    /// This does not change whether the [`Link`] is active or not.
+    /// This does not change whether the [`GenericLink`] is active or not.
     #[props(default)]
     pub new_tab: bool,
     /// The onclick event handler.

+ 1 - 1
packages/router/src/components/outlet.rs

@@ -5,7 +5,7 @@ use dioxus::prelude::*;
 ///
 /// Only works as descendant of a [`GenericRouter`] component, otherwise it will be inactive.
 ///
-/// The [`GenericOutlet`] is aware of how many [`Outlet`]s it is nested within. It will render the content
+/// The [`GenericOutlet`] is aware of how many [`GenericOutlet`]s it is nested within. It will render the content
 /// of the active route that is __exactly as deep__.
 ///
 /// # Panic