[PATCH 0/1] MR398: include: Fix some confusingly structured documentation.

[PATCH 1/1] include: Fix some confusingly structured documentation.

[Zebediah Figura]

From: Zebediah Figura

Fixes: 7a4ae434dfa4cccc1e832455133930066d2ab575.
---
 include/vkd3d_shader.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index 9d0d768b4..f112e7c75 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -1387,7 +1387,10 @@ struct vkd3d_shader_descriptor_info
  * as follows:
  *
  * - Each constant register set used by the shader is scanned as a single
- *   constant buffer descriptor, as follows:
+ *   constant buffer descriptor.
+ *   There may therefore be up to three such descriptors, one for each register
+ *   set used by the shader: float, integer, and boolean.
+ *   The fields are set as follows:
  *   * The \ref vkd3d_shader_descriptor_info.type field is set to
  *     VKD3D_SHADER_DESCRIPTOR_TYPE_CBV.
  *   * The \ref vkd3d_shader_descriptor_info.register_space field is set to zero.
@@ -1407,9 +1410,6 @@ struct vkd3d_shader_descriptor_info
  *   * The \ref vkd3d_shader_descriptor_info.register_index field is set to the
  *     binding index of the original sampler, for both descriptors.
  *   * The \ref vkd3d_shader_descriptor_info.count field is set to one.
- *
- * In summary, there may be up to three such descriptors, one for each register
- * set used by the shader: float, integer, and boolean.
  */
 struct vkd3d_shader_scan_descriptor_info
 {

[PATCH 0/1] MR398: include: Fix some confusingly structured documentation. - approved

[Henri Verbeet (＠hverbeet)]

This merge request was approved by Henri Verbeet.