Fix broken links between codegen and http crates.

Also resolves link warnings emitted by rustdoc.

Closes #2594
This commit is contained in:
Sergio Benitez 2023-09-20 17:17:22 -07:00
parent bbb124eeea
commit f41474dd61
8 changed files with 17 additions and 14 deletions

View File

@ -1457,6 +1457,7 @@ pub fn catchers(input: TokenStream) -> TokenStream {
/// are not ignorable. /// are not ignorable.
/// ///
/// [`Uri`]: ../rocket/http/uri/enum.Uri.html /// [`Uri`]: ../rocket/http/uri/enum.Uri.html
/// [`Uri::parse_any()`]: ../rocket/http/uri/enum.Uri.html#method.parse_any
/// [`Origin`]: ../rocket/http/uri/struct.Origin.html /// [`Origin`]: ../rocket/http/uri/struct.Origin.html
/// [`Asterisk`]: ../rocket/http/uri/struct.Asterisk.html /// [`Asterisk`]: ../rocket/http/uri/struct.Asterisk.html
/// [`Authority`]: ../rocket/http/uri/struct.Authority.html /// [`Authority`]: ../rocket/http/uri/struct.Authority.html

View File

@ -178,7 +178,7 @@ use crate::uri::fmt::{self, Part};
/// assert_eq!(uri.query().unwrap(), "name=Robert%20Mike&nickname=Bob"); /// assert_eq!(uri.query().unwrap(), "name=Robert%20Mike&nickname=Bob");
/// ``` /// ```
/// ///
/// [`uri!`]: rocket::uri /// [`uri!`]: ../../../../rocket/macro.uri.html
/// [`FromUriParam::Target`]: crate::uri::fmt::FromUriParam::Target /// [`FromUriParam::Target`]: crate::uri::fmt::FromUriParam::Target
/// [`Path`]: crate::uri::fmt::Path /// [`Path`]: crate::uri::fmt::Path
/// [`Query`]: crate::uri::fmt::Query /// [`Query`]: crate::uri::fmt::Query

View File

@ -106,7 +106,7 @@ use crate::uri::fmt::{Part, Path, Query, Formatter};
/// seen, the implementations will be used to display the value in a URI-safe /// seen, the implementations will be used to display the value in a URI-safe
/// manner. /// manner.
/// ///
/// [`uri!`]: rocket::uri /// [`uri!`]: ../../../../rocket/macro.uri.html
/// ///
/// # Provided Implementations /// # Provided Implementations
/// ///

View File

@ -1,9 +1,8 @@
//! Types and traits to build and send responses. //! Types and traits to build and send responses.
//! //!
//! The return type of a Rocket handler can be any type that implements the //! The return type of a Rocket handler can be any type that implements the
//! [`Responder`](crate::response::Responder) trait, which means that the type knows //! [`Responder`] trait, which means that the type knows how to generate a
//! how to generate a [`Response`]. Among other things, this module contains //! [`Response`]. Among other things, this module contains several such types.
//! several such types.
//! //!
//! # Composing //! # Composing
//! //!

View File

@ -351,9 +351,9 @@ impl Event {
/// # Responder /// # Responder
/// ///
/// `EventStream` is a (potentially infinite) responder. The response /// `EventStream` is a (potentially infinite) responder. The response
/// `Content-Type` is set to [`EventStream`](ContentType::EventStream). The body /// `Content-Type` is set to [`EventStream`](const@ContentType::EventStream).
/// is [unsized](crate::response::Body#unsized), and values are sent as soon as /// The body is [unsized](crate::response::Body#unsized), and values are sent as
/// they are yielded by the internal iterator. /// soon as they are yielded by the internal iterator.
/// ///
/// ## Heartbeat /// ## Heartbeat
/// ///

View File

@ -1,6 +1,6 @@
//! Automatic JSON (de)serialization support. //! Automatic JSON (de)serialization support.
//! //!
//! See [`Json`](Json) for details. //! See [`Json`] for details.
//! //!
//! # Enabling //! # Enabling
//! //!

View File

@ -1,6 +1,6 @@
//! Automatic MessagePack (de)serialization support. //! Automatic MessagePack (de)serialization support.
//! //!
//! See [`MsgPack`](crate::serde::msgpack::MsgPack) for further details. //! See [`MsgPack`] for further details.
//! //!
//! # Enabling //! # Enabling
//! //!

View File

@ -20,10 +20,13 @@ fi
echo ":::: Generating the docs..." echo ":::: Generating the docs..."
pushd "${PROJECT_ROOT}" > /dev/null 2>&1 pushd "${PROJECT_ROOT}" > /dev/null 2>&1
# Set the crate version and fill in missing doc URLs with docs.rs links. # Set the crate version and fill in missing doc URLs with docs.rs links.
RUSTDOCFLAGS="-Zunstable-options --crate-version ${DOC_VERSION}" \ RUSTDOCFLAGS="-Zunstable-options --crate-version ${DOC_VERSION} --extern-html-root-url rocket=https://api.rocket.rs/rocket/" \
cargo doc -p rocket \ cargo doc -Zrustdoc-map --no-deps --all-features \
-p rocket_sync_db_pools -p rocket_dyn_templates -p rocket_db_pools -p rocket_ws \ -p rocket \
-Zrustdoc-map --no-deps --all-features -p rocket_db_pools \
-p rocket_sync_db_pools \
-p rocket_dyn_templates \
-p rocket_ws
popd > /dev/null 2>&1 popd > /dev/null 2>&1
# Blank index, for redirection. # Blank index, for redirection.