gfx-rs / gfx

[maintenance mode] A low-overhead Vulkan-like GPU API for Rust.
http://gfx-rs.github.io/
Apache License 2.0
5.36k stars 546 forks source link

Fixed missing or wrong name links on documentation. #3745

Closed Uniformbuffer3 closed 3 years ago

Uniformbuffer3 commented 3 years ago

Running cargo doc on the vulkan backend will generate the following error:

error: unresolved link to `Device::reset_fences`
   --> src/hal/src/device.rs:558:26
    |
558 |     /// [`reset_fences`][Device::reset_fences].
    |                          ^^^^^^^^^^^^^^^^^^^^ the trait `Device` has no associated item named `reset_fences`
    |
note: the lint level is defined here
   --> src/hal/src/lib.rs:9:5
    |
9   |     broken_intra_doc_links,
    |     ^^^^^^^^^^^^^^^^^^^^^^

error: unresolved link to `CommandQueue::bind_sparse`
   --> src/hal/src/memory.rs:134:41
    |
134 | /// This is used in the [`bind_sparse`][CommandQueue::bind_sparse] method to define a physical
    |                                         ^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `CommandQueue` in scope

error: unresolved link to `CommandQueue::bind_sparse`
   --> src/hal/src/memory.rs:151:41
    |
151 | /// This is used in the [`bind_sparse`][CommandQueue::bind_sparse] method to define a physical
    |                                         ^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `CommandQueue` in scope

error: aborting due to 3 previous errors

This fix will simply update the doc links so that it compile correctly. Have a good day.

bors[bot] commented 3 years ago

Build succeeded: