💡 Normaliza comentarios en varios archivos

This commit is contained in:
Manuel Cillero 2025-07-25 23:05:53 +02:00
parent 2dfca51c31
commit 3789d05a40
7 changed files with 19 additions and 9 deletions

View file

@ -162,7 +162,7 @@ pub static CONFIG_VALUES: LazyLock<ConfigBuilder<DefaultState>> = LazyLock::new(
/// Incluye los ajustes necesarios de la configuración anticipando valores por defecto. /// Incluye los ajustes necesarios de la configuración anticipando valores por defecto.
/// ///
/// ### Sintaxis /// # Sintaxis
/// ///
/// Hay que añadir en nuestra librería el siguiente código: /// Hay que añadir en nuestra librería el siguiente código:
/// ///
@ -182,7 +182,7 @@ pub static CONFIG_VALUES: LazyLock<ConfigBuilder<DefaultState>> = LazyLock::new(
/// * **Lista de pares** con las claves TOML que requieran valores por defecto. Siguen la notación /// * **Lista de pares** con las claves TOML que requieran valores por defecto. Siguen la notación
/// `"seccion.subclave"` para coincidir con el árbol TOML. /// `"seccion.subclave"` para coincidir con el árbol TOML.
/// ///
/// ### Ejemplo básico /// # Ejemplo básico
/// ///
/// ```rust,no_run /// ```rust,no_run
/// use pagetop::prelude::*; /// use pagetop::prelude::*;
@ -212,7 +212,7 @@ pub static CONFIG_VALUES: LazyLock<ConfigBuilder<DefaultState>> = LazyLock::new(
/// } /// }
/// ``` /// ```
/// ///
/// ### Buenas prácticas /// # Buenas prácticas
/// ///
/// * **Valores por defecto**. Declara un valor por defecto para cada clave obligatoria. Las claves /// * **Valores por defecto**. Declara un valor por defecto para cada clave obligatoria. Las claves
/// opcionales pueden ser `Option<T>`. /// opcionales pueden ser `Option<T>`.
@ -227,7 +227,7 @@ pub static CONFIG_VALUES: LazyLock<ConfigBuilder<DefaultState>> = LazyLock::new(
/// * **Errores explícitos**. Si la deserialización falla, la macro lanzará un `panic!` con un /// * **Errores explícitos**. Si la deserialización falla, la macro lanzará un `panic!` con un
/// mensaje que indica la estructura problemática, facilitando la depuración. /// mensaje que indica la estructura problemática, facilitando la depuración.
/// ///
/// ### Requisitos /// # Requisitos
/// ///
/// * Dependencia `serde` con la *feature* `derive`. /// * Dependencia `serde` con la *feature* `derive`.
/// * Las claves deben coincidir con los campos (*snake case*) de tu estructura `Settings_Type`. /// * Las claves deben coincidir con los campos (*snake case*) de tu estructura `Settings_Type`.

View file

@ -44,10 +44,12 @@ pub fn add_action(action: ActionBox) {
/// acción específica. /// acción específica.
/// ///
/// # Parámetros genéricos /// # Parámetros genéricos
///
/// - `A`: Tipo de acción que esperamos procesar. Debe implementar [`ActionDispatcher`]. /// - `A`: Tipo de acción que esperamos procesar. Debe implementar [`ActionDispatcher`].
/// - `F`: Función asociada a cada acción, devuelve un valor de tipo `B`. /// - `F`: Función asociada a cada acción, devuelve un valor de tipo `B`.
/// ///
/// # Ejemplo de uso /// # Ejemplo de uso
///
/// ```rust,ignore /// ```rust,ignore
/// pub(crate) fn dispatch(component: &mut C, cx: &mut Context) { /// pub(crate) fn dispatch(component: &mut C, cx: &mut Context) {
/// dispatch_actions( /// dispatch_actions(

View file

@ -278,7 +278,8 @@ impl IntoIterator for Children {
/// Consume la estructura `Children`, devolviendo un iterador que consume los elementos. /// Consume la estructura `Children`, devolviendo un iterador que consume los elementos.
/// ///
/// ### Ejemplo de uso: /// # Ejemplo de uso:
///
/// ```rust#ignore /// ```rust#ignore
/// let children = Children::new().with(child1).with(child2); /// let children = Children::new().with(child1).with(child2);
/// for child in children { /// for child in children {
@ -296,7 +297,8 @@ impl<'a> IntoIterator for &'a Children {
/// Itera sobre una referencia inmutable de `Children`, devolviendo un iterador de referencia. /// Itera sobre una referencia inmutable de `Children`, devolviendo un iterador de referencia.
/// ///
/// ### Ejemplo de uso: /// # Ejemplo de uso:
///
/// ```rust#ignore /// ```rust#ignore
/// let children = Children::new().with(child1).with(child2); /// let children = Children::new().with(child1).with(child2);
/// for child in &children { /// for child in &children {
@ -314,7 +316,8 @@ impl<'a> IntoIterator for &'a mut Children {
/// Itera sobre una referencia mutable de `Children`, devolviendo un iterador mutable. /// Itera sobre una referencia mutable de `Children`, devolviendo un iterador mutable.
/// ///
/// ### Ejemplo de uso: /// # Ejemplo de uso:
///
/// ```rust#ignore /// ```rust#ignore
/// let mut children = Children::new().with(child1).with(child2); /// let mut children = Children::new().with(child1).with(child2);
/// for child in &mut children { /// for child in &mut children {

View file

@ -21,12 +21,14 @@ pub enum ClassesOp {
/// Permite construir y modificar dinámicamente con [`ClassesOp`] una lista de clases CSS /// Permite construir y modificar dinámicamente con [`ClassesOp`] una lista de clases CSS
/// normalizadas. /// normalizadas.
/// ///
/// ### Normalización /// # Normalización
///
/// - El [orden de las clases no es relevante](https://stackoverflow.com/a/1321712) en CSS. /// - El [orden de las clases no es relevante](https://stackoverflow.com/a/1321712) en CSS.
/// - No se permiten clases duplicadas. /// - No se permiten clases duplicadas.
/// - Las clases vacías se ignoran. /// - Las clases vacías se ignoran.
/// ///
/// # Ejemplo /// # Ejemplo
///
/// ```rust /// ```rust
/// use pagetop::prelude::*; /// use pagetop::prelude::*;
/// ///

View file

@ -5,6 +5,7 @@ use crate::{builder_fn, AutoDefault};
/// Este tipo encapsula `Option<String>` garantizando un valor normalizado para su uso. /// Este tipo encapsula `Option<String>` garantizando un valor normalizado para su uso.
/// ///
/// # Normalización /// # Normalización
///
/// - Se eliminan los espacios al principio y al final. /// - Se eliminan los espacios al principio y al final.
/// - Se sustituyen los espacios intermedios por guiones bajos (`_`). /// - Se sustituyen los espacios intermedios por guiones bajos (`_`).
/// - Si el resultado es una cadena vacía, se guarda `None`. /// - Si el resultado es una cadena vacía, se guarda `None`.

View file

@ -5,11 +5,12 @@ use crate::{builder_fn, AutoDefault};
/// Este tipo encapsula `Option<String>` garantizando un valor normalizado para su uso. /// Este tipo encapsula `Option<String>` garantizando un valor normalizado para su uso.
/// ///
/// # Normalización /// # Normalización
///
/// - Se eliminan los espacios al principio y al final. /// - Se eliminan los espacios al principio y al final.
/// - Se sustituyen los espacios intermedios por guiones bajos (`_`). /// - Se sustituyen los espacios intermedios por guiones bajos (`_`).
/// - Si el resultado es una cadena vacía, se guarda `None`. /// - Si el resultado es una cadena vacía, se guarda `None`.
/// ///
/// ## Ejemplo /// # Ejemplo
/// ///
/// ```rust /// ```rust
/// use pagetop::prelude::*; /// use pagetop::prelude::*;

View file

@ -5,6 +5,7 @@ use crate::{builder_fn, AutoDefault};
/// Este tipo encapsula `Option<String>` garantizando un valor normalizado para su uso. /// Este tipo encapsula `Option<String>` garantizando un valor normalizado para su uso.
/// ///
/// # Normalización /// # Normalización
///
/// - Se eliminan los espacios al principio y al final. /// - Se eliminan los espacios al principio y al final.
/// - Si el resultado es una cadena vacía, se guarda `None`. /// - Si el resultado es una cadena vacía, se guarda `None`.
/// ///