Zebediah Figura : include: Add documentation for enum vkd3d_shader_structure_type.

[Alexandre Julliard]

Module: vkd3d
Branch: master
Commit: 73f1adfd22c26ac03d6136fe8b381b574889bd10
URL:    https://source.winehq.org/git/vkd3d.git/?a=commit;h=73f1adfd22c26ac03d6136fe...

Author: Zebediah Figura <z.figura12(a)gmail.com>
Date:   Mon Aug 31 20:34:27 2020 -0500

include: Add documentation for enum vkd3d_shader_structure_type.

Signed-off-by: Zebediah Figura <z.figura12(a)gmail.com>
Signed-off-by: Henri Verbeet <hverbeet(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>

---

 include/vkd3d_shader.h | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index 1f2a9c2..da05f2c 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -27,14 +27,31 @@
 extern "C" {
 #endif  /* __cplusplus */
 
+/**
+ * \file vkd3d_shader.h
+ *
+ * \since 1.2
+ *
+ * This file contains definitions for the vkd3d-shader library.
+ *
+ * The vkd3d-shader library provides multiple utilities related to the
+ * compilation, transformation, and reflection of GPU shaders.
+ */
+
+/** The type of a chained structure. */
 enum vkd3d_shader_structure_type
 {
-    /* 1.2 */
+    /** The structure is a vkd3d_shader_compile_info structure. */
     VKD3D_SHADER_STRUCTURE_TYPE_COMPILE_INFO,
+    /** The structure is a vkd3d_shader_interface_info structure. */
     VKD3D_SHADER_STRUCTURE_TYPE_INTERFACE_INFO,
+    /** The structure is a vkd3d_shader_scan_descriptor_info structure. */
     VKD3D_SHADER_STRUCTURE_TYPE_SCAN_DESCRIPTOR_INFO,
+    /** The structure is a vkd3d_shader_spirv_domain_shader_target_info structure. */
     VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_DOMAIN_SHADER_TARGET_INFO,
+    /** The structure is a vkd3d_shader_spirv_target_info structure. */
     VKD3D_SHADER_STRUCTURE_TYPE_SPIRV_TARGET_INFO,
+    /** The structure is a vkd3d_shader_transform_feedback_info structure. */
     VKD3D_SHADER_STRUCTURE_TYPE_TRANSFORM_FEEDBACK_INFO,
 
     VKD3D_FORCE_32_BIT_ENUM(VKD3D_SHADER_STRUCTURE_TYPE),