📝 Retoques de documentación en html y componentes

This commit is contained in:
Manuel Cillero 2026-07-09 00:08:04 +02:00
parent 25713a8a13
commit 9e8cd77140
3 changed files with 13 additions and 13 deletions

View file

@ -175,7 +175,7 @@ impl<C: Component> Embed<C> {
/// ///
/// # Ejemplo /// # Ejemplo
/// ///
/// ```rust,no_run /// ```rust
/// # use pagetop::prelude::*; /// # use pagetop::prelude::*;
/// let embed = Embed::with(Html::with(|_| html! { "Prueba" })); /// let embed = Embed::with(Html::with(|_| html! { "Prueba" }));
/// if let Some(component) = embed.get() { /// if let Some(component) = embed.get() {

View file

@ -297,16 +297,13 @@ pub trait Contextual: LangId {
/// # } /// # }
/// fn use_context(cx: &mut Context) { /// fn use_context(cx: &mut Context) {
/// // Recupera el tema seleccionado. /// // Recupera el tema seleccionado.
/// let active_theme = cx.theme(); /// let _theme = cx.theme(); // short_name() => "basic" por defecto
/// assert_eq!(active_theme.short_name(), "aliner");
/// ///
/// // Recupera el parámetro a su tipo original. /// // Recupera el parámetro a su tipo original.
/// let id: i32 = *cx.param::<i32>("user_id").unwrap(); /// let _id: i32 = *cx.param::<i32>("user_id").unwrap(); // => 42
/// assert_eq!(id, 42);
/// ///
/// // Genera un identificador para un componente de tipo `Menu`. /// // Genera un identificador para un componente de tipo `Menu`.
/// let unique_id = cx.build_id::<Menu>(1); /// let _unique_id = cx.build_id::<Menu>(1); // => "menu-1" si es el primero
/// assert_eq!(unique_id, "menu-1"); // Si es el primero generado.
/// } /// }
/// ``` /// ```
#[rustfmt::skip] #[rustfmt::skip]

View file

@ -7,11 +7,14 @@ use crate::core::component::Context;
use crate::html::{Markup, html}; use crate::html::{Markup, html};
use crate::{AutoDefault, Weight}; use crate::{AutoDefault, Weight};
/// Representación genérica de un script [`JavaScript`](crate::html::JavaScript) o una hoja de /// Representación genérica de un activo de un documento HTML gestionado por [`Assets`].
/// estilos [`StyleSheet`](crate::html::StyleSheet).
/// ///
/// Estos recursos se incluyen en los conjuntos de recursos ([`Assets`]) que suelen renderizarse en /// Puede ser un script [`JavaScript`](crate::html::JavaScript), una hoja de estilos
/// un documento HTML. /// [`StyleSheet`](crate::html::StyleSheet) o un recurso precargado
/// [`Preload`](crate::html::Preload).
///
/// Estos recursos se incluyen en los conjuntos de recursos [`Assets`] que suelen renderizarse en un
/// documento HTML.
/// ///
/// Cada recurso se identifica por un **nombre único** ([`Asset::name()`]), usado como clave; y un /// Cada recurso se identifica por un **nombre único** ([`Asset::name()`]), usado como clave; y un
/// **peso** ([`Asset::weight()`]), que determina su orden relativo de renderizado. /// **peso** ([`Asset::weight()`]), que determina su orden relativo de renderizado.
@ -26,8 +29,8 @@ pub trait Asset {
fn render(&self, cx: &mut Context) -> Markup; fn render(&self, cx: &mut Context) -> Markup;
} }
/// Gestión común para conjuntos de recursos como [`JavaScript`](crate::html::JavaScript) y /// Gestión común de recursos [`JavaScript`](crate::html::JavaScript),
/// [`StyleSheet`](crate::html::StyleSheet). /// [`StyleSheet`](crate::html::StyleSheet) y [`Preload`](crate::html::Preload).
/// ///
/// Se emplea normalmente para agrupar, administrar y renderizar los recursos de un documento HTML. /// Se emplea normalmente para agrupar, administrar y renderizar los recursos de un documento HTML.
/// Cada recurso se identifica por un nombre único ([`Asset::name()`]) y tiene asociado un peso /// Cada recurso se identifica por un nombre único ([`Asset::name()`]) y tiene asociado un peso