From 09cbf2f37186233507bb4444713a53fbf21599ee Mon Sep 17 00:00:00 2001 From: Sergio Benitez Date: Wed, 20 Sep 2023 17:17:22 -0700 Subject: [PATCH] Fix broken links between codegen and http crates. Also resolves link warnings emitted by rustdoc. Closes #2594 --- core/codegen/src/lib.rs | 1 + core/http/src/uri/fmt/from_uri_param.rs | 2 +- core/http/src/uri/fmt/uri_display.rs | 2 +- core/lib/src/response/mod.rs | 5 ++--- core/lib/src/response/stream/sse.rs | 6 +++--- core/lib/src/serde/json.rs | 2 +- core/lib/src/serde/msgpack.rs | 2 +- scripts/mk-docs.sh | 11 +++++++---- 8 files changed, 17 insertions(+), 14 deletions(-) diff --git a/core/codegen/src/lib.rs b/core/codegen/src/lib.rs index 08b06dea..7cec0eb0 100644 --- a/core/codegen/src/lib.rs +++ b/core/codegen/src/lib.rs @@ -1457,6 +1457,7 @@ pub fn catchers(input: TokenStream) -> TokenStream { /// are not ignorable. /// /// [`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 /// [`Asterisk`]: ../rocket/http/uri/struct.Asterisk.html /// [`Authority`]: ../rocket/http/uri/struct.Authority.html diff --git a/core/http/src/uri/fmt/from_uri_param.rs b/core/http/src/uri/fmt/from_uri_param.rs index 0850b905..ae162e9b 100644 --- a/core/http/src/uri/fmt/from_uri_param.rs +++ b/core/http/src/uri/fmt/from_uri_param.rs @@ -178,7 +178,7 @@ use crate::uri::fmt::{self, Part}; /// 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 /// [`Path`]: crate::uri::fmt::Path /// [`Query`]: crate::uri::fmt::Query diff --git a/core/http/src/uri/fmt/uri_display.rs b/core/http/src/uri/fmt/uri_display.rs index fb8902ff..b8e630e0 100644 --- a/core/http/src/uri/fmt/uri_display.rs +++ b/core/http/src/uri/fmt/uri_display.rs @@ -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 /// manner. /// -/// [`uri!`]: rocket::uri +/// [`uri!`]: ../../../../rocket/macro.uri.html /// /// # Provided Implementations /// diff --git a/core/lib/src/response/mod.rs b/core/lib/src/response/mod.rs index 22b26eb6..71f0ff69 100644 --- a/core/lib/src/response/mod.rs +++ b/core/lib/src/response/mod.rs @@ -1,9 +1,8 @@ //! Types and traits to build and send responses. //! //! 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 -//! how to generate a [`Response`]. Among other things, this module contains -//! several such types. +//! [`Responder`] trait, which means that the type knows how to generate a +//! [`Response`]. Among other things, this module contains several such types. //! //! # Composing //! diff --git a/core/lib/src/response/stream/sse.rs b/core/lib/src/response/stream/sse.rs index 31774972..b123f632 100644 --- a/core/lib/src/response/stream/sse.rs +++ b/core/lib/src/response/stream/sse.rs @@ -351,9 +351,9 @@ impl Event { /// # Responder /// /// `EventStream` is a (potentially infinite) responder. The response -/// `Content-Type` is set to [`EventStream`](ContentType::EventStream). The body -/// is [unsized](crate::response::Body#unsized), and values are sent as soon as -/// they are yielded by the internal iterator. +/// `Content-Type` is set to [`EventStream`](const@ContentType::EventStream). +/// The body is [unsized](crate::response::Body#unsized), and values are sent as +/// soon as they are yielded by the internal iterator. /// /// ## Heartbeat /// diff --git a/core/lib/src/serde/json.rs b/core/lib/src/serde/json.rs index 3f8ffe5f..dfc85a6b 100644 --- a/core/lib/src/serde/json.rs +++ b/core/lib/src/serde/json.rs @@ -1,6 +1,6 @@ //! Automatic JSON (de)serialization support. //! -//! See [`Json`](Json) for details. +//! See [`Json`] for details. //! //! # Enabling //! diff --git a/core/lib/src/serde/msgpack.rs b/core/lib/src/serde/msgpack.rs index bb9867e3..e77c6aa7 100644 --- a/core/lib/src/serde/msgpack.rs +++ b/core/lib/src/serde/msgpack.rs @@ -1,6 +1,6 @@ //! Automatic MessagePack (de)serialization support. //! -//! See [`MsgPack`](crate::serde::msgpack::MsgPack) for further details. +//! See [`MsgPack`] for further details. //! //! # Enabling //! diff --git a/scripts/mk-docs.sh b/scripts/mk-docs.sh index 93659d09..ed813625 100755 --- a/scripts/mk-docs.sh +++ b/scripts/mk-docs.sh @@ -20,10 +20,13 @@ fi echo ":::: Generating the docs..." pushd "${PROJECT_ROOT}" > /dev/null 2>&1 # Set the crate version and fill in missing doc URLs with docs.rs links. - RUSTDOCFLAGS="-Zunstable-options --crate-version ${DOC_VERSION}" \ - cargo doc -p rocket \ - -p rocket_sync_db_pools -p rocket_dyn_templates -p rocket_db_pools -p rocket_ws \ - -Zrustdoc-map --no-deps --all-features + RUSTDOCFLAGS="-Zunstable-options --crate-version ${DOC_VERSION} --extern-html-root-url rocket=https://api.rocket.rs/rocket/" \ + cargo doc -Zrustdoc-map --no-deps --all-features \ + -p rocket \ + -p rocket_db_pools \ + -p rocket_sync_db_pools \ + -p rocket_dyn_templates \ + -p rocket_ws popd > /dev/null 2>&1 # Blank index, for redirection.