Fix new clippy::doc_markdown warnings.

Author: eddyb

crates/spirv-std/src/arch/demote_to_helper_invocation_ext.rs

@@ -5,7 +5,7 @@ use core::arch::asm;
 /// `discard()` in HLSL. Any stores to memory after this instruction are
 /// suppressed and the fragment does not write outputs to the framebuffer.
 ///
-/// Unlike [super::kill], this does not necessarily terminate the invocation. It
+/// Unlike [`super::kill`], this does not necessarily terminate the invocation. It
 /// is not considered a flow control instruction (flow control does not become
 /// non-uniform) and does not terminate the block.
 ///

crates/spirv-std/src/arch/mesh_shading.rs

@@ -16,7 +16,7 @@ use core::arch::asm;
 /// There must not be any control flow path to an output write that is not preceded
 /// by this instruction.
 ///
-/// This instruction is only valid in the *MeshEXT* Execution Model.
+/// This instruction is only valid in the *`MeshEXT`* Execution Model.
 #[spirv_std_macros::gpu_only]
 #[doc(alias = "OpSetMeshOutputsEXT")]
 #[inline]
@@ -38,22 +38,22 @@ pub unsafe fn set_mesh_outputs_ext(vertex_count: u32, primitive_count: u32) {
 /// for the launch of child mesh tasks. See Vulkan API specification for more detail.
 ///
 /// 'Payload' is an optional pointer to the payload structure to pass to the generated mesh shader invocations.
-/// 'Payload' must be the result of an *OpVariable* with a storage class of *TaskPayloadWorkgroupEXT*.
+/// 'Payload' must be the result of an *`OpVariable`* with a storage class of *`TaskPayloadWorkgroupEXT`*.
 ///
 /// The arguments are taken from the first invocation in each workgroup.
 /// Any invocation must execute this instruction exactly once and under uniform
 /// control flow.
 /// This instruction also serves as an *OpControlBarrier* instruction, and also
 /// performs and adheres to the description and semantics of an *OpControlBarrier*
 /// instruction with the 'Execution' and 'Memory' operands set to *Workgroup* and
-/// the 'Semantics' operand set to a combination of *WorkgroupMemory* and
-/// *AcquireRelease*.
+/// the 'Semantics' operand set to a combination of *`WorkgroupMemory`* and
+/// *`AcquireRelease`*.
 /// Ceases all further processing: Only instructions executed before
-/// *OpEmitMeshTasksEXT* have observable side effects.
+/// *`OpEmitMeshTasksEXT`* have observable side effects.
 ///
 /// This instruction must be the last instruction in a block.
 ///
-/// This instruction is only valid in the *TaskEXT* Execution Model.
+/// This instruction is only valid in the *`TaskEXT`* Execution Model.
 #[spirv_std_macros::gpu_only]
 #[doc(alias = "OpEmitMeshTasksEXT")]
 #[inline]
@@ -77,22 +77,22 @@ pub unsafe fn emit_mesh_tasks_ext(group_count_x: u32, group_count_y: u32, group_
 /// for the launch of child mesh tasks. See Vulkan API specification for more detail.
 ///
 /// 'Payload' is an optional pointer to the payload structure to pass to the generated mesh shader invocations.
-/// 'Payload' must be the result of an *OpVariable* with a storage class of *TaskPayloadWorkgroupEXT*.
+/// 'Payload' must be the result of an *`OpVariable`* with a storage class of *`TaskPayloadWorkgroupEXT`*.
 ///
 /// The arguments are taken from the first invocation in each workgroup.
 /// Any invocation must execute this instruction exactly once and under uniform
 /// control flow.
 /// This instruction also serves as an *OpControlBarrier* instruction, and also
 /// performs and adheres to the description and semantics of an *OpControlBarrier*
 /// instruction with the 'Execution' and 'Memory' operands set to *Workgroup* and
-/// the 'Semantics' operand set to a combination of *WorkgroupMemory* and
-/// *AcquireRelease*.
+/// the 'Semantics' operand set to a combination of *`WorkgroupMemory`* and
+/// *`AcquireRelease`*.
 /// Ceases all further processing: Only instructions executed before
-/// *OpEmitMeshTasksEXT* have observable side effects.
+/// *`OpEmitMeshTasksEXT`* have observable side effects.
 ///
 /// This instruction must be the last instruction in a block.
 ///
-/// This instruction is only valid in the *TaskEXT* Execution Model.
+/// This instruction is only valid in the *`TaskEXT`* Execution Model.
 #[spirv_std_macros::gpu_only]
 #[doc(alias = "OpEmitMeshTasksEXT")]
 #[inline]

crates/spirv-std/src/arch/ray_tracing.rs

@@ -14,7 +14,7 @@ use core::arch::asm;
 /// - `hit_kind` is the integer hit kind reported back to other shaders and
 ///   accessible by the `hit kind` builtin.
 ///
-/// This instruction is allowed only in IntersectionKHR execution model.
+/// This instruction is allowed only in `IntersectionKHR` execution model.
 ///
 /// This instruction is a shader call instruction which may invoke shaders with
 /// the `any_hit` execution model.

crates/spirv-std/src/arch/subgroup.rs

@@ -844,7 +844,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -875,7 +875,7 @@ Result Type must be a scalar or vector of floating-point type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type. The method used to perform the group operation on the contributed Value(s) from active invocations is implementation defined.
 
@@ -908,7 +908,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 1. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 1. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -939,7 +939,7 @@ Result Type must be a scalar or vector of floating-point type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 1. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 1. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type. The method used to perform the group operation on the contributed Value(s) from active invocations is implementation defined.
 
@@ -959,7 +959,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is INT_MAX.
+The identity I for Operation is `INT_MAX`.
 
 The type of `value` must be the same as Result Type.
 
@@ -972,7 +972,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is INT_MAX. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is `INT_MAX`. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -990,7 +990,7 @@ Result Type must be a scalar or vector of integer type, whose Signedness operand
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is UINT_MAX.
+The identity I for Operation is `UINT_MAX`.
 
 The type of `value` must be the same as Result Type.
 
@@ -1003,7 +1003,7 @@ Result Type must be a scalar or vector of integer type, whose Signedness operand
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is UINT_MAX. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is `UINT_MAX`. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1034,7 +1034,7 @@ Result Type must be a scalar or vector of floating-point type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is +INF. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is +INF. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type. The method used to perform the group operation on the contributed Value(s) from active invocations is implementation defined. From the set of Value(s) provided by active invocations within a subgroup, if for any two Values one of them is a NaN, the other is chosen. If all Value(s) that are used by the current invocation are NaN, then the result is an undefined value.
 
@@ -1054,7 +1054,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is INT_MIN.
+The identity I for Operation is `INT_MIN`.
 
 The type of `value` must be the same as Result Type.
 
@@ -1067,7 +1067,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is INT_MIN. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is `INT_MIN`. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1098,7 +1098,7 @@ Result Type must be a scalar or vector of integer type, whose Signedness operand
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1160,7 +1160,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is ~0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is ~0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1193,7 +1193,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1226,7 +1226,7 @@ Result Type must be a scalar or vector of integer type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1259,7 +1259,7 @@ Result Type must be a scalar or vector of Boolean type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is ~0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is ~0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1292,7 +1292,7 @@ Result Type must be a scalar or vector of Boolean type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 
@@ -1325,7 +1325,7 @@ Result Type must be a scalar or vector of Boolean type.
 
 Execution is a Scope that identifies the group of invocations affected by this command. It must be Subgroup.
 
-The identity I for Operation is 0. If Operation is ClusteredReduce, `ClusterSize` must be present.
+The identity I for Operation is 0. If Operation is `ClusteredReduce`, `ClusterSize` must be present.
 
 The type of `value` must be the same as Result Type.
 

crates/spirv-std/src/image.rs

@@ -95,7 +95,7 @@ pub type Cubemap = crate::Image!(cube, type=f32, sampled, __crate_root=crate);
 /// You likely want to write this type using the [`crate::Image!`] macro helper, as the generic
 /// arguments here can get extremely verbose.
 ///
-/// See SPIR-V OpTypeImage specification for the meaning of integer parameters.
+/// See SPIR-V `OpTypeImage` specification for the meaning of integer parameters.
 #[spirv(generic_image_type)]
 #[derive(Copy, Clone)]
 // HACK(eddyb) avoids "transparent newtype of `_anti_zst_padding`" misinterpretation.