[PATCH 0/3] MR95: Add missing public headers to Doxygen documentation.

[Giovanni Mascellani (＠giomasce)]

The Doxygen docs still need quite a lot of love, but at least the generated document lists the available functions!

[PATCH 1/3] vkd3d-shader: Fix the Doxygen documentation for vkd3d_shader.h.

[Giovanni Mascellani]

From: Giovanni Mascellani

The \since field was too early, and prevented Doxygen from really
parsing the synopsis for vkd3d_shader.h.
---
 include/vkd3d_shader.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index 86ffb9d5..49725ff9 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -30,12 +30,12 @@ extern "C" {
 /**
  * \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.
+ *
+ * \since 1.2
  */

/** \since 1.3 */

[PATCH 2/3] vkd3d: Generate Doxygen documentation for vkd3d.h.

[Giovanni Mascellani]

From: Giovanni Mascellani

---
 include/vkd3d.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/include/vkd3d.h b/include/vkd3d.h
index b44f0084..76b1ba65 100644
--- a/include/vkd3d.h
+++ b/include/vkd3d.h
@@ -34,6 +34,18 @@
 extern "C" {
 #endif  /* __cplusplus */

+/**
+ * \file vkd3d.h
+ *
+ * This file contains definitions for the vkd3d library.
+ *
+ * The vkd3d library is a 3D graphics library built on top of
+ * Vulkan. It has an API very similar, but not identical, to
+ * Direct3D 12.
+ *
+ * \since 1.0
+ */
+
 enum vkd3d_structure_type
 {
     /* 1.0 */

[PATCH 3/3] vkd3d-utils: Generate Doxygen documentation for vkd3d_utils.h.

[Giovanni Mascellani]

From: Giovanni Mascellani

---
 include/vkd3d_utils.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/include/vkd3d_utils.h b/include/vkd3d_utils.h
index 6e84b176..e8462563 100644
--- a/include/vkd3d_utils.h
+++ b/include/vkd3d_utils.h
@@ -29,6 +29,17 @@
 extern "C" {
 #endif  /* __cplusplus */

+/**
+ * \file vkd3d_utils.h
+ *
+ * This file contains definitions for the vkd3d-utils library.
+ *
+ * The vkd3d-utils library is a collections of routines to ease the
+ * porting of a Direct3D 12 application to vkd3d.
+ *
+ * \since 1.0
+ */
+
 #define VKD3D_WAIT_OBJECT_0 (0)
 #define VKD3D_WAIT_TIMEOUT (1)
 #define VKD3D_WAIT_FAILED (~0u)

[PATCH 0/3] MR95: Add missing public headers to Doxygen documentation. - approved

[Henri Verbeet (＠hverbeet)]

This merge request was approved by Henri Verbeet.

[PATCH 0/3] MR95: Add missing public headers to Doxygen documentation. - approved

[Zebediah Figura (＠zfigura)]

This merge request was approved by Zebediah Figura.