mirror of https://github.com/rwf2/Rocket.git
Fix various broken rustdoc links.
This commit is contained in:
parent
08510302da
commit
198b6f0e97
|
@ -584,9 +584,10 @@ impl<T> From<r2d2::Error> for Error<T> {
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// In this example, `ConnectionManager::new()` method returns a `foo::Error` on
|
/// In this example, `ConnectionManager::new()` method returns a `foo::Error` on
|
||||||
/// failure. For convenience, the [`DbError`] enum is used to consolidate this
|
/// failure. The [`Error`] enum consolidates this type, the `r2d2::Error` type
|
||||||
/// error type and the `r2d2::Error` type that can result from
|
/// that can result from `r2d2::Pool::builder()`, and the
|
||||||
/// `r2d2::Pool::builder()` or `database::Config::from()`.
|
/// [`figment::Error`](rocket::figment::Error) type from
|
||||||
|
/// `database::Config::from()`.
|
||||||
///
|
///
|
||||||
/// In the event that a connection manager isn't fallible (as is the case with
|
/// In the event that a connection manager isn't fallible (as is the case with
|
||||||
/// Diesel's r2d2 connection manager, for instance), the associated error type
|
/// Diesel's r2d2 connection manager, for instance), the associated error type
|
||||||
|
|
|
@ -47,13 +47,13 @@
|
||||||
//! [X-DNS-Prefetch-Control]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-DNS-Prefetch-Control
|
//! [X-DNS-Prefetch-Control]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-DNS-Prefetch-Control
|
||||||
//! [clickjacking]: https://en.wikipedia.org/wiki/Clickjacking
|
//! [clickjacking]: https://en.wikipedia.org/wiki/Clickjacking
|
||||||
//!
|
//!
|
||||||
//! [`XssFilter`]: helmet::XssFilter
|
//! [`XssFilter`]: self::XssFilter
|
||||||
//! [`NoSniff`]: helmet::NoSniff
|
//! [`NoSniff`]: self::NoSniff
|
||||||
//! [`Frame`]: helmet::Frame
|
//! [`Frame`]: self::Frame
|
||||||
//! [`Hsts`]: helmet::Hsts
|
//! [`Hsts`]: self::Hsts
|
||||||
//! [`ExpectCt`]: helmet::ExpectCt
|
//! [`ExpectCt`]: self::ExpectCt
|
||||||
//! [`Referrer`]: helmet::Referrer
|
//! [`Referrer`]: self::Referrer
|
||||||
//! [`Prefetch`]: helmet::Prefetch
|
//! [`Prefetch`]: self::Prefetch
|
||||||
//!
|
//!
|
||||||
//! # Usage
|
//! # Usage
|
||||||
//!
|
//!
|
||||||
|
|
|
@ -173,7 +173,7 @@ impl Config {
|
||||||
/// environment variable. If it is not set, it defaults to `debug` when
|
/// environment variable. If it is not set, it defaults to `debug` when
|
||||||
/// compiled in debug mode and `release` when compiled in release mode.
|
/// compiled in debug mode and `release` when compiled in release mode.
|
||||||
///
|
///
|
||||||
/// [`rocket::ignite()`]: crate::rocket::ignite()
|
/// [`rocket::ignite()`]: crate::ignite()
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
///
|
||||||
|
|
|
@ -36,7 +36,7 @@
|
||||||
//! [`rocket::ignite()`]. The configured provider can be built on top of
|
//! [`rocket::ignite()`]. The configured provider can be built on top of
|
||||||
//! [`Config::figment()`], [`Config::default()`], both, or neither. The
|
//! [`Config::figment()`], [`Config::default()`], both, or neither. The
|
||||||
//! [Figment](@figment) documentation has full details on instantiating existing
|
//! [Figment](@figment) documentation has full details on instantiating existing
|
||||||
//! providers like [`Toml`]() and [`Json`] as well as creating custom providers for
|
//! providers like [`Toml`]() and [`Env`] as well as creating custom providers for
|
||||||
//! more complex cases.
|
//! more complex cases.
|
||||||
//!
|
//!
|
||||||
//! Configuration values can be overridden at runtime by merging figment's tuple
|
//! Configuration values can be overridden at runtime by merging figment's tuple
|
||||||
|
@ -92,10 +92,10 @@
|
||||||
//! }
|
//! }
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
//! [`rocket::custom()`]: crate::rocket::custom()
|
//! [`rocket::custom()`]: crate::custom()
|
||||||
//! [`rocket::ignite()`]: crate::rocket::ignite()
|
//! [`rocket::ignite()`]: crate::ignite()
|
||||||
//! [`Toml`]: figment::providers::Toml
|
//! [`Toml`]: figment::providers::Toml
|
||||||
//! [`Json`]: figment::providers::Json
|
//! [`Env`]: figment::providers::Env
|
||||||
|
|
||||||
mod secret_key;
|
mod secret_key;
|
||||||
mod config;
|
mod config;
|
||||||
|
|
|
@ -35,7 +35,7 @@ pub struct TlsConfig {
|
||||||
impl TlsConfig {
|
impl TlsConfig {
|
||||||
/// Constructs a `TlsConfig` from paths to a `certs` certificate-chain
|
/// Constructs a `TlsConfig` from paths to a `certs` certificate-chain
|
||||||
/// a `key` private-key. This method does no validation; it simply creates a
|
/// a `key` private-key. This method does no validation; it simply creates a
|
||||||
/// structure suitable for passing into a [`Config`].
|
/// structure suitable for passing into a [`Config`](crate::Config).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
///
|
||||||
|
@ -55,7 +55,8 @@ impl TlsConfig {
|
||||||
|
|
||||||
/// Constructs a `TlsConfig` from byte buffers to a `certs`
|
/// Constructs a `TlsConfig` from byte buffers to a `certs`
|
||||||
/// certificate-chain a `key` private-key. This method does no validation;
|
/// certificate-chain a `key` private-key. This method does no validation;
|
||||||
/// it simply creates a structure suitable for passing into a [`Config`].
|
/// it simply creates a structure suitable for passing into a
|
||||||
|
/// [`Config`](crate::Config).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
///
|
||||||
|
|
|
@ -458,7 +458,7 @@ impl Rocket {
|
||||||
|
|
||||||
/// Creates a new `Rocket` application using the supplied configuration
|
/// Creates a new `Rocket` application using the supplied configuration
|
||||||
/// provider. This method is typically called through the
|
/// provider. This method is typically called through the
|
||||||
/// [`rocket::custom()`] alias.
|
/// [`rocket::custom()`](crate::custom()) alias.
|
||||||
///
|
///
|
||||||
/// # Panics
|
/// # Panics
|
||||||
///
|
///
|
||||||
|
|
Loading…
Reference in New Issue