Skip to content

Commit 0fd7327

Browse files
authored
Use link text in docs to omit Self:: prefix in rendered docs (#561)
Suggestion from [#559]. [#559]: #559 (comment)
1 parent b5a2744 commit 0fd7327

File tree

8 files changed

+21
-21
lines changed

8 files changed

+21
-21
lines changed

ash/src/device.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ impl Device {
297297
.get_buffer_memory_requirements2(self.handle(), info, out);
298298
}
299299

300-
/// Retrieve the number of elements to pass to [`Self::get_image_sparse_memory_requirements2()`]
300+
/// Retrieve the number of elements to pass to [`get_image_sparse_memory_requirements2()`][Self::get_image_sparse_memory_requirements2()]
301301
pub unsafe fn get_image_sparse_memory_requirements2_len(
302302
&self,
303303
info: &vk::ImageSparseMemoryRequirementsInfo2,
@@ -314,7 +314,7 @@ impl Device {
314314

315315
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetImageSparseMemoryRequirements2.html>
316316
///
317-
/// Call [`Self::get_image_sparse_memory_requirements2_len()`] to query the number of elements to pass to `out`.
317+
/// Call [`get_image_sparse_memory_requirements2_len()`][Self::get_image_sparse_memory_requirements2_len()] to query the number of elements to pass to `out`.
318318
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
319319
pub unsafe fn get_image_sparse_memory_requirements2(
320320
&self,

ash/src/entry.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,10 +264,10 @@ impl Entry {
264264
&self.entry_fn_1_1
265265
}
266266

267-
#[deprecated = "This function is unavailable and therefore panics on Vulkan 1.0, please use `try_enumerate_instance_version` instead"]
267+
#[deprecated = "This function is unavailable and therefore panics on Vulkan 1.0, please use `try_enumerate_instance_version()` instead"]
268268
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkEnumerateInstanceVersion.html>
269269
///
270-
/// Please use [`Self::try_enumerate_instance_version`] instead.
270+
/// Please use [`try_enumerate_instance_version()`][Self::try_enumerate_instance_version()] instead.
271271
pub fn enumerate_instance_version(&self) -> VkResult<u32> {
272272
unsafe {
273273
let mut api_version = 0;

ash/src/extensions/khr/get_memory_requirements2.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ impl GetMemoryRequirements2 {
3939
.get_image_memory_requirements2_khr(self.handle, info, memory_requirements);
4040
}
4141

42-
/// Retrieve the number of elements to pass to [`Self::get_image_sparse_memory_requirements2()`]
42+
/// Retrieve the number of elements to pass to [`get_image_sparse_memory_requirements2()`][Self::get_image_sparse_memory_requirements2()]
4343
pub unsafe fn get_image_sparse_memory_requirements2_len(
4444
&self,
4545
info: &vk::ImageSparseMemoryRequirementsInfo2KHR,
@@ -56,7 +56,7 @@ impl GetMemoryRequirements2 {
5656

5757
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetImageSparseMemoryRequirements2KHR.html>
5858
///
59-
/// Call [`Self::get_image_sparse_memory_requirements2_len()`] to query the number of elements to pass to `out`.
59+
/// Call [`get_image_sparse_memory_requirements2_len()`][Self::get_image_sparse_memory_requirements2_len()] to query the number of elements to pass to `out`.
6060
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
6161
pub unsafe fn get_image_sparse_memory_requirements2(
6262
&self,

ash/src/extensions/khr/get_physical_device_properties2.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ impl GetPhysicalDeviceProperties2 {
7878
.get_physical_device_properties2_khr(physical_device, properties);
7979
}
8080

81-
/// Retrieve the number of elements to pass to [`Self::get_physical_device_queue_family_properties2()`]
81+
/// Retrieve the number of elements to pass to [`get_physical_device_queue_family_properties2()`][Self::get_physical_device_queue_family_properties2()]
8282
pub unsafe fn get_physical_device_queue_family_properties2_len(
8383
&self,
8484
physical_device: vk::PhysicalDevice,
@@ -94,7 +94,7 @@ impl GetPhysicalDeviceProperties2 {
9494

9595
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetPhysicalDeviceQueueFamilyProperties2KHR.html>
9696
///
97-
/// Call [`Self::get_physical_device_queue_family_properties2_len()`] to query the number of elements to pass to `out`.
97+
/// Call [`get_physical_device_queue_family_properties2_len()`][Self::get_physical_device_queue_family_properties2_len()] to query the number of elements to pass to `out`.
9898
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
9999
pub unsafe fn get_physical_device_queue_family_properties2(
100100
&self,
@@ -110,7 +110,7 @@ impl GetPhysicalDeviceProperties2 {
110110
assert_eq!(count as usize, out.len());
111111
}
112112

113-
/// Retrieve the number of elements to pass to [`Self::get_physical_device_sparse_image_format_properties2()`]
113+
/// Retrieve the number of elements to pass to [`get_physical_device_sparse_image_format_properties2()`][Self::get_physical_device_sparse_image_format_properties2()]
114114
pub unsafe fn get_physical_device_sparse_image_format_properties2_len(
115115
&self,
116116
physical_device: vk::PhysicalDevice,
@@ -129,7 +129,7 @@ impl GetPhysicalDeviceProperties2 {
129129

130130
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetPhysicalDeviceSparseImageFormatProperties2KHR.html>
131131
///
132-
/// Call [`Self::get_physical_device_sparse_image_format_properties2_len()`] to query the number of elements to pass to `out`.
132+
/// Call [`get_physical_device_sparse_image_format_properties2_len()`][Self::get_physical_device_sparse_image_format_properties2_len()] to query the number of elements to pass to `out`.
133133
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
134134
pub unsafe fn get_physical_device_sparse_image_format_properties2(
135135
&self,

ash/src/extensions/khr/get_surface_capabilities2.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ impl GetSurfaceCapabilities2 {
3333
.result_with_success(surface_capabilities)
3434
}
3535

36-
/// Retrieve the number of elements to pass to [`Self::get_physical_device_surface_formats2()`]
36+
/// Retrieve the number of elements to pass to [`get_physical_device_surface_formats2()`][Self::get_physical_device_surface_formats2()]
3737
pub unsafe fn get_physical_device_surface_formats2_len(
3838
&self,
3939
physical_device: vk::PhysicalDevice,
@@ -51,7 +51,7 @@ impl GetSurfaceCapabilities2 {
5151

5252
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetPhysicalDeviceSurfaceFormats2KHR.html>
5353
///
54-
/// Call [`Self::get_physical_device_surface_formats2_len()`] to query the number of elements to pass to `out`.
54+
/// Call [`get_physical_device_surface_formats2_len()`][Self::get_physical_device_surface_formats2_len()] to query the number of elements to pass to `out`.
5555
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
5656
pub unsafe fn get_physical_device_surface_formats2(
5757
&self,

ash/src/extensions/khr/maintenance4.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ impl Maintenance4 {
3838
.get_device_image_memory_requirements_khr(self.handle, create_info, out)
3939
}
4040

41-
/// Retrieve the number of elements to pass to [`Self::get_device_image_sparse_memory_requirements()`]
41+
/// Retrieve the number of elements to pass to [`get_device_image_sparse_memory_requirements()`][Self::get_device_image_sparse_memory_requirements()]
4242
pub unsafe fn get_device_image_sparse_memory_requirements_len(
4343
&self,
4444
create_info: &vk::DeviceImageMemoryRequirementsKHR,
@@ -55,7 +55,7 @@ impl Maintenance4 {
5555

5656
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetDeviceImageSparseMemoryRequirementsKHR.html>
5757
///
58-
/// Call [`Self::get_device_image_sparse_memory_requirements_len()`] to query the number of elements to pass to `out`.
58+
/// Call [`get_device_image_sparse_memory_requirements_len()`][Self::get_device_image_sparse_memory_requirements_len()] to query the number of elements to pass to `out`.
5959
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
6060
pub unsafe fn get_device_image_sparse_memory_requirements(
6161
&self,

ash/src/instance.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ impl Instance {
5151
&self.instance_fn_1_1
5252
}
5353

54-
/// Retrieve the number of elements to pass to [`Self::enumerate_physical_device_groups()`]
54+
/// Retrieve the number of elements to pass to [`enumerate_physical_device_groups()`][Self::enumerate_physical_device_groups()]
5555
pub unsafe fn enumerate_physical_device_groups_len(&self) -> VkResult<usize> {
5656
let mut group_count = 0;
5757
self.instance_fn_1_1
@@ -61,7 +61,7 @@ impl Instance {
6161

6262
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkEnumeratePhysicalDeviceGroups.html>
6363
///
64-
/// Call [`Self::enumerate_physical_device_groups_len()`] to query the number of elements to pass to `out`.
64+
/// Call [`enumerate_physical_device_groups_len()`][Self::enumerate_physical_device_groups_len()] to query the number of elements to pass to `out`.
6565
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
6666
pub unsafe fn enumerate_physical_device_groups(
6767
&self,
@@ -122,7 +122,7 @@ impl Instance {
122122
.result()
123123
}
124124

125-
/// Retrieve the number of elements to pass to [`Self::get_physical_device_queue_family_properties2()`]
125+
/// Retrieve the number of elements to pass to [`get_physical_device_queue_family_properties2()`][Self::get_physical_device_queue_family_properties2()]
126126
pub unsafe fn get_physical_device_queue_family_properties2_len(
127127
&self,
128128
physical_device: vk::PhysicalDevice,
@@ -139,7 +139,7 @@ impl Instance {
139139

140140
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetPhysicalDeviceQueueFamilyProperties2.html>
141141
///
142-
/// Call [`Self::get_physical_device_queue_family_properties2_len()`] to query the number of elements to pass to `out`.
142+
/// Call [`get_physical_device_queue_family_properties2_len()`][Self::get_physical_device_queue_family_properties2_len()] to query the number of elements to pass to `out`.
143143
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
144144
pub unsafe fn get_physical_device_queue_family_properties2(
145145
&self,
@@ -166,7 +166,7 @@ impl Instance {
166166
.get_physical_device_memory_properties2(physical_device, out);
167167
}
168168

169-
/// Retrieve the number of elements to pass to [`Self::get_physical_device_sparse_image_format_properties2()`]
169+
/// Retrieve the number of elements to pass to [`get_physical_device_sparse_image_format_properties2()`][Self::get_physical_device_sparse_image_format_properties2()]
170170
pub unsafe fn get_physical_device_sparse_image_format_properties2_len(
171171
&self,
172172
physical_device: vk::PhysicalDevice,
@@ -185,7 +185,7 @@ impl Instance {
185185

186186
/// <https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/vkGetPhysicalDeviceSparseImageFormatProperties2.html>
187187
///
188-
/// Call [`Self::get_physical_device_sparse_image_format_properties2_len()`] to query the number of elements to pass to `out`.
188+
/// Call [`get_physical_device_sparse_image_format_properties2_len()`][Self::get_physical_device_sparse_image_format_properties2_len()] to query the number of elements to pass to `out`.
189189
/// Be sure to [`Default::default()`]-initialize these elements and optionally set their `p_next` pointer.
190190
pub unsafe fn get_physical_device_sparse_image_format_properties2(
191191
&self,

ash/src/vk/prelude.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ impl Packed24_8 {
3434
use vk::ColorComponentFlags;
3535

3636
impl ColorComponentFlags {
37-
/// Contraction of [`Self::R`] | [`Self::G`] | [`Self::B`] | [`Self::A`]
37+
/// Contraction of [`R`][Self::R] | [`G`][Self::G] | [`B`][Self::B] | [`A`][Self::A]
3838
pub const RGBA: Self = Self(Self::R.0 | Self::G.0 | Self::B.0 | Self::A.0);
3939
}
4040

0 commit comments

Comments
 (0)