From 5c1723c9833c133e1af641533293e63d8723f8d3 Mon Sep 17 00:00:00 2001 From: Martin Robinson Date: Mon, 22 Jan 2024 14:13:48 +0100 Subject: rustdoc: Fix many rustdoc errors (#31147) This fixes many rustdoc errors that occur due to raw URLs in rustdoc comments as well as unescaped Rust code that should be in backticks. --- components/net/connector.rs | 2 +- components/net/cookie.rs | 2 +- components/net/cookie_storage.rs | 2 +- components/net/fetch/methods.rs | 2 +- components/net/hsts.rs | 2 +- components/net/http_loader.rs | 2 +- components/net/image_cache.rs | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) (limited to 'components/net') diff --git a/components/net/connector.rs b/components/net/connector.rs index 3c8cffb3fbd..8adb7f74696 100644 --- a/components/net/connector.rs +++ b/components/net/connector.rs @@ -137,7 +137,7 @@ pub enum CACertificates { /// /// FIXME: The `ignore_certificate_errors` argument ignores all certificate errors. This /// is used when running the WPT tests, because rustls currently rejects the WPT certificiate. -/// See https://github.com/servo/servo/issues/30080 +/// See pub fn create_tls_config( ca_certificates: CACertificates, ignore_certificate_errors: bool, diff --git a/components/net/cookie.rs b/components/net/cookie.rs index d65c98daf18..7ce8e1d6ddf 100644 --- a/components/net/cookie.rs +++ b/components/net/cookie.rs @@ -3,7 +3,7 @@ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ //! Implementation of cookie creation and matching as specified by -//! http://tools.ietf.org/html/rfc6265 +//! use std::borrow::ToOwned; use std::net::{Ipv4Addr, Ipv6Addr}; diff --git a/components/net/cookie_storage.rs b/components/net/cookie_storage.rs index e1ee56e0967..d6fef773589 100644 --- a/components/net/cookie_storage.rs +++ b/components/net/cookie_storage.rs @@ -3,7 +3,7 @@ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ //! Implementation of cookie storage as specified in -//! http://tools.ietf.org/html/rfc6265 +//! use std::cmp::Ordering; use std::collections::hash_map::Entry; diff --git a/components/net/fetch/methods.rs b/components/net/fetch/methods.rs index 5c5f6942f54..f98297b197b 100644 --- a/components/net/fetch/methods.rs +++ b/components/net/fetch/methods.rs @@ -164,7 +164,7 @@ pub async fn fetch_with_cors_cache( main_fetch(request, cache, false, false, target, &mut None, &context).await; } -/// https://www.w3.org/TR/CSP/#should-block-request +/// pub fn should_request_be_blocked_by_csp(request: &Request) -> csp::CheckResult { let origin = match &request.origin { Origin::Client => return csp::CheckResult::Allowed, diff --git a/components/net/hsts.rs b/components/net/hsts.rs index 681e754fd76..2d521cac821 100644 --- a/components/net/hsts.rs +++ b/components/net/hsts.rs @@ -144,7 +144,7 @@ impl HstsList { } } - /// Step 2.9 of https://fetch.spec.whatwg.org/#concept-main-fetch. + /// Step 2.9 of . pub fn apply_hsts_rules(&self, url: &mut ServoUrl) { if url.scheme() != "http" && url.scheme() != "ws" { return; diff --git a/components/net/http_loader.rs b/components/net/http_loader.rs index 17f12b13c1b..bb75ebc5653 100644 --- a/components/net/http_loader.rs +++ b/components/net/http_loader.rs @@ -223,7 +223,7 @@ fn strict_origin_when_cross_origin( strip_url_for_use_as_referrer(referrer_url, true) } -/// https://html.spec.whatwg.org/multipage/#schemelessly-same-site +/// fn is_schemelessy_same_site(site_a: &ImmutableOrigin, site_b: &ImmutableOrigin) -> bool { // Step 1 if !site_a.is_tuple() && !site_b.is_tuple() && site_a == site_b { diff --git a/components/net/image_cache.rs b/components/net/image_cache.rs index 36750205053..684b57c2e20 100644 --- a/components/net/image_cache.rs +++ b/components/net/image_cache.rs @@ -94,7 +94,7 @@ fn set_webrender_image_key(webrender_api: &WebrenderIpcSender, image: &mut Image // Aux structs and enums. // ====================================================================== -/// https://html.spec.whatwg.org/multipage/#list-of-available-images +/// type ImageKey = (ServoUrl, ImmutableOrigin, Option); // Represents all the currently pending loads/decodings. For -- cgit v1.2.3