🩹 Corrige estructura de documentación en doc.rs

This commit is contained in:
Manuel Cillero 2023-05-16 21:10:10 +02:00
parent cf55c0d1f2
commit dc2ff3259e
12 changed files with 34 additions and 14 deletions

View file

@ -80,3 +80,6 @@ tokio = { version = "1.28.1", features = ["macros", "rt-multi-thread"] }
[build-dependencies]
pagetop-build = { version = "0.0", path = "../pagetop-build" }
[package.metadata.docs.rs]
all-features = true

View file

@ -1,3 +1,5 @@
//! Instancia y ejecuta una aplicación creada con **PageTop**.
mod figfont;
use crate::core::{module, module::ModuleStaticRef};

View file

@ -1,4 +1,4 @@
//! Gestión de la configuración.
//! Lectura y uso de ajustes de configuración.
//!
//! Carga la configuración de la aplicación en forma de pares `clave = valor` recogidos en archivos
//! [TOML](https://toml.io).
@ -158,13 +158,13 @@ pub static CONFIG: LazyStatic<ConfigData> = LazyStatic::new(|| {
});
#[macro_export]
/// Asigna los ajustes de configuración de tu módulo usando tipos seguros y valores predefinidos.
/// Define un conjunto de ajustes de configuración usando tipos seguros y valores predefinidos.
///
/// Detiene la aplicación con un panic! si no pueden asignarse los ajustes de configuración.
///
/// Ver [`Cómo añadir ajustes de configuración`](config/index.html#cómo-añadir-ajustes-de-configuración).
macro_rules! define_config {
( $SETTINGS:ident: $Settings:ty $(, $key:literal => $value:literal)*$(,)* ) => {
( $SETTINGS:ident as $Settings:ty $(, $key:literal => $value:literal)*$(,)* ) => {
$crate::doc_comment! {
concat!(
"Declara y asigna los valores predefinidos para los ajustes de configuración ",
@ -274,7 +274,7 @@ pub struct Server {
pub bind_port: u16,
}
define_config!(SETTINGS: Settings,
define_config!(SETTINGS as Settings,
// [app]
"app.name" => "PageTop Application",
"app.description" => "Developed with the amazing PageTop framework.",

View file

@ -1,11 +1,13 @@
//! Tipos y funciones esenciales para crear módulos, temas, componentes y acciones.
// API to add new features with modules and themes.
pub mod module;
// API to build new components.
pub mod component;
// API to define functions that alter the behavior of PageTop core.
pub mod hook;
// API to add new features with modules and themes.
pub mod module;
// Basic theme.
mod basic;

View file

@ -1,3 +1,5 @@
//! Acceso unificado y normalizado a base de datos.
use crate::{config, run_now, trace, LazyStatic, ResultExt};
pub use url::Url as DbUri;

View file

@ -1,3 +1,5 @@
//! HTML en código.
pub use maud::{html, Markup, PreEscaped, DOCTYPE};
mod assets;

View file

@ -1,6 +1,6 @@
//! <div align="center">
//!
//! <img src="https://raw.githubusercontent.com/manuelcillero/pagetop/main/pagetop/static/pagetop-banner.png" />
//! <img src="https://raw.githubusercontent.com/manuelcillero/pagetop/main/banner/pagetop.png" />
//!
//! <h1>PageTop</h1>
//!
@ -12,9 +12,9 @@
//! **PageTop** es un entorno de desarrollo basado en Rust que reúne algunos de los crates más
//! estables y populares para crear soluciones web modulares, extensibles y configurables.
//!
//! PageTop añade una capa de abstracción para definir una interfaz única que ofrezca de partida:
//! PageTop define un interfaz único que ofrece:
//!
//! * Gestión de la configuración ([`config`]).
//! * Lectura y uso de ajustes de configuración ([`config`]).
//!
//! * Registro de trazas y eventos de la aplicación ([`trace`]).
//!
@ -22,9 +22,9 @@
//!
//! * HTML en código ([`html`]).
//!
//! * Acceso a base de datos ([`db`]).
//! * Acceso unificado y normalizado a base de datos ([`db`]).
//!
//! * APIs esenciales para crear componentes, acciones, módulos y temas ([`core`]).
//! * Tipos y funciones esenciales para crear módulos, temas, componentes y acciones ([`core`]).
//!
//! * Tipos de respuestas a peticiones web ([`response`])
//!
@ -76,7 +76,7 @@ pub mod html;
#[cfg(feature = "database")]
pub mod db;
// APIs esenciales para crear componentes, acciones, módulos y temas.
// APIs esenciales para crear módulos, temas, componentes y acciones.
pub mod core;
// API del servidor web.

View file

@ -122,7 +122,7 @@ pub static LANGID: LazyStatic<LanguageIdentifier> =
});
#[macro_export]
/// Permite integrar fácilmente localización en temas, módulos y componentes.
/// Define un conjunto de elementos de localización y funciones locales de traducción.
macro_rules! define_locale {
( $dir_locales:literal $(, $core_locales:literal)? ) => {
use $crate::locale::*;

View file

@ -1,3 +1,6 @@
//! Re-exporta los tipos y funciones más habituales para la creación de soluciones web con
//! **PageTop**.
// Re-exports.
pub use crate::{concat_string, fn_builder, Handle, HashMapResources, LazyStatic, ResultExt};

View file

@ -1,3 +1,5 @@
//! Tipos de respuestas a peticiones web.
pub use actix_web::ResponseError;
pub mod page;

View file

@ -1,3 +1,5 @@
//! Tipos y funciones para operar con el servidor web ([actix-web](https://docs.rs/actix-web)).
pub use actix_web::{
http, web, App, HttpMessage, HttpRequest, HttpResponse, HttpServer, Responder,
};

View file

@ -1,3 +1,5 @@
//! Funciones útiles.
use crate::Handle;
// https://stackoverflow.com/a/71464396