Skip to content

Commit fdd1d6a

Browse files
committed
[wgpu] Fix warnings in cargo doc --document-private-items.
Fix some broken and outdated links in documentation for private items. CI only checks `wgpu`'s public interface.
1 parent 718d585 commit fdd1d6a

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

wgpu/src/api/device.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,9 @@ impl Device {
165165
/// thus it's the caller responsibility to pass a shader which doesn't perform any of this
166166
/// operations.
167167
///
168-
/// See the documentation for [`ShaderRuntimeChecks`][src] for more information about specific checks.
168+
/// See the documentation for [`ShaderRuntimeChecks`] for more information about specific checks.
169169
///
170170
/// [csm]: Self::create_shader_module
171-
/// [src]: crate::ShaderRuntimeChecks
172171
#[must_use]
173172
pub unsafe fn create_shader_module_trusted(
174173
&self,

wgpu/src/api/surface.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ static_assertions::assert_impl_all!(SurfaceConfiguration: Send, Sync);
2626
/// [`GPUCanvasContext`](https://gpuweb.github.io/gpuweb/#canvas-context)
2727
/// serves a similar role.
2828
pub struct Surface<'window> {
29-
/// Additional surface data returned by [`DynContext::instance_create_surface`].
29+
/// Additional surface data returned by [`InstanceInterface::create_surface`][cs].
30+
///
31+
/// [cs]: crate::dispatch::InstanceInterface::create_surface
3032
pub(crate) inner: dispatch::DispatchSurface,
3133

3234
// Stores the latest `SurfaceConfiguration` that was set using `Surface::configure`.
@@ -408,8 +410,11 @@ pub(crate) enum CreateSurfaceErrorKind {
408410
#[cfg_attr(not(webgpu), expect(dead_code))]
409411
Web(String),
410412

411-
/// Error when trying to get a [`DisplayHandle`] or a [`WindowHandle`] from
412-
/// `raw_window_handle`.
413+
/// Error when trying to get a [`RawDisplayHandle`][rdh] or a
414+
/// [`RawWindowHandle`][rwh] from a [`SurfaceTarget`].
415+
///
416+
/// [rdh]: raw_window_handle::RawDisplayHandle
417+
/// [rwh]: raw_window_handle::RawWindowHandle
413418
RawHandle(raw_window_handle::HandleError),
414419
}
415420
static_assertions::assert_impl_all!(CreateSurfaceError: Send, Sync);

0 commit comments

Comments
 (0)