From 699c06cdc35bd7b28c85c3847d8540e5002b1250 Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Thu, 6 Oct 2022 13:07:46 -0700 Subject: [PATCH] cargo doc: fix warnings BUG=None TEST=tools/cargo-doc Change-Id: I332849dd0df415f634df4c9ad664176f8b8891cf Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3936732 Commit-Queue: Daniel Verkamp Reviewed-by: Dennis Kempin --- devices/src/virtio/gpu/edid.rs | 2 +- devices/src/virtio/queue.rs | 2 +- devices/src/virtio/snd/common_backend/stream_info.rs | 2 +- devices/src/virtio/vhost/user/device/snd.rs | 2 +- kernel_loader/src/lib.rs | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/devices/src/virtio/gpu/edid.rs b/devices/src/virtio/gpu/edid.rs index 87d624bbf7..bd04e0fbcd 100644 --- a/devices/src/virtio/gpu/edid.rs +++ b/devices/src/virtio/gpu/edid.rs @@ -3,7 +3,7 @@ // found in the LICENSE file. //! Implementation of the EDID specification provided by software. -//! EDID spec: https://glenwing.github.io/docs/VESA-EEDID-A2.pdf +//! EDID spec: use std::fmt; use std::fmt::Debug; diff --git a/devices/src/virtio/queue.rs b/devices/src/virtio/queue.rs index 62cf49f3e4..f9b9cd7eea 100644 --- a/devices/src/virtio/queue.rs +++ b/devices/src/virtio/queue.rs @@ -479,7 +479,7 @@ impl Queue { Ok(()) } - /// Releases memory exported by a previous call to [export_memory]. + /// Releases memory exported by a previous call to [`Queue::export_memory()`]. pub fn release_exported_memory(&mut self) { self.exported_desc_table = None; self.exported_avail_ring = None; diff --git a/devices/src/virtio/snd/common_backend/stream_info.rs b/devices/src/virtio/snd/common_backend/stream_info.rs index 0f1764f8a3..07661472b1 100644 --- a/devices/src/virtio/snd/common_backend/stream_info.rs +++ b/devices/src/virtio/snd/common_backend/stream_info.rs @@ -97,7 +97,7 @@ impl Drop for StreamInfo { impl StreamInfo { /// Creates a new [`StreamInfo`]. /// - /// * `stream_source_generator`: Generator which generates stream source in [`prepare()`]. + /// * `stream_source_generator`: Generator which generates stream source in [`StreamInfo::prepare()`]. pub fn new(stream_source_generator: Box) -> Self { StreamInfo { stream_source: None, diff --git a/devices/src/virtio/vhost/user/device/snd.rs b/devices/src/virtio/vhost/user/device/snd.rs index fd100ffa66..66b78d72c5 100644 --- a/devices/src/virtio/vhost/user/device/snd.rs +++ b/devices/src/virtio/vhost/user/device/snd.rs @@ -289,7 +289,7 @@ pub struct Options { /// comma separated key=value pairs for setting up cras snd devices. /// Possible key values: /// capture - Enable audio capture. Default to false. - /// backend(null,[cras]) - Which backend to use for vhost-snd. + /// backend - Which backend to use for vhost-snd (null|cras). /// client_type - Set specific client type for cras backend. /// socket_type - Set socket type for cras backend. /// num_output_devices - Set number of output PCM devices. diff --git a/kernel_loader/src/lib.rs b/kernel_loader/src/lib.rs index 7bfcb00432..08922668eb 100644 --- a/kernel_loader/src/lib.rs +++ b/kernel_loader/src/lib.rs @@ -82,7 +82,7 @@ pub enum Error { pub type Result = std::result::Result; #[derive(Debug, Copy, Clone, PartialEq)] -/// Information about a kernel loaded with the [`load_kernel`] function. +/// Information about a kernel loaded with the [`load_elf`] function. pub struct LoadedKernel { /// Address range containg the bounds of the loaded program headers. /// `address_range.start` is the start of the lowest loaded program header.