Correct a variety of documentation issues (#34786)

Fix some warnings in documentation as well as some faulty documentation
introduced in #34776.

Signed-off-by: Martin Robinson <mrobinson@igalia.com>
This commit is contained in:
Martin Robinson 2024-12-29 11:37:57 +01:00 committed by GitHub
parent 3aa9e00e4e
commit 93ae8d22fc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 20 additions and 19 deletions

View file

@ -55,7 +55,7 @@ pub fn sandbox_access_files_dirs() -> Vec<PathBuf> {
}
pub enum Resource {
/// A json file of [`Preferences`](servo_config::pref_util::Preferences) configuration.
/// A json file of `servo_config::pref_util::Preferences` configuration.
/// It can be empty but lots of features will be disabled.
Preferences,
/// A list of GATT services that are blocked from being used by web bluetooth.
@ -70,9 +70,9 @@ pub enum Resource {
/// It can be empty but all domain names will be considered not public suffixes.
DomainList,
/// A preloaded list of HTTP Strict Transport Security. It can be an empty list and
/// [`HstsList::default()`](net::hsts::HstsList) will be called.
/// `HstsList::default()` will be called.
HstsPreloadList,
/// A HTML page to display when [`SslValidation`](net_traits::NetworkError::SslValidation) network error is
/// A HTML page to display when `net_traits::NetworkError::SslValidation` network error is
/// reported.
/// The page contains placeholder `${reason}` for the error code and `${bytes}` for the certificate bytes,
/// and also `${secret}` for the privileged secret.