Updated documentation for Vulkan backend interfaces

Author: TheMostDiligent

Graphics/GraphicsEngineVulkan/interface/BufferVk.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,6 +59,8 @@ DILIGENT_BEGIN_INTERFACE(IBufferVk, IBuffer)
     VIRTUAL void METHOD(SetAccessFlags)(THIS_
                                         VkAccessFlags AccessFlags) PURE;
 
+    /// Returns Vulkan access flags corresponding to the buffer state.
+
     /// If the buffer state is known to the engine (i.e. not Diligent::RESOURCE_STATE_UNKNOWN),
     /// returns Vulkan access flags corresponding to the state. If the state is unknown, returns 0.
     VIRTUAL VkAccessFlags METHOD(GetAccessFlags)(THIS) CONST PURE;

Graphics/GraphicsEngineVulkan/interface/DeviceContextVk.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -73,16 +73,16 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContextVk, IDeviceContext)
 
     /// \return - handle to the current command buffer
     ///
-    /// \remarks  Any command on the device context may potentially submit the command buffer for
-    ///           execution into the command queue and make it invalid. An application should
-    ///           never cache the handle and should instead request the command buffer every time it
-    ///           needs it.
+    /// Any command on the device context may potentially submit the command buffer for
+    /// execution into the command queue and make it invalid. An application should
+    /// never cache the handle and should instead request the command buffer every time it
+    /// needs it.
     ///
-    ///           Diligent Engine internally keeps track of all resource state changes (vertex and index
-    ///           buffers, pipeline states, render targets, etc.). If an application changes any of these
-    ///           states in the command buffer, it must invalidate the engine's internal state tracking by
-    ///           calling IDeviceContext::InvalidateState() and then manually restore all required states via
-    ///           appropriate Diligent API calls.
+    /// Diligent Engine internally keeps track of all resource state changes (vertex and index
+    /// buffers, pipeline states, render targets, etc.). If an application changes any of these
+    /// states in the command buffer, it must invalidate the engine's internal state tracking by
+    /// calling IDeviceContext::InvalidateState() and then manually restore all required states via
+    /// appropriate Diligent API calls.
     VIRTUAL VkCommandBuffer METHOD(GetVkCommandBuffer)(THIS) PURE;
 };
 DILIGENT_END_INTERFACE

Graphics/GraphicsEngineVulkan/interface/DeviceMemoryVk.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -57,6 +57,7 @@ struct DeviceMemoryRangeVk
     VkDeviceSize   Offset  DEFAULT_INITIALIZER(0);
 
     /// Memory range size in bytes.
+
     /// When IDeviceMemoryVk::GetRange() succeeds, the size is equal to the Size argument
     /// that was given to the function, and zero otherwise.
     VkDeviceSize   Size    DEFAULT_INITIALIZER(0);

Graphics/GraphicsEngineVulkan/interface/RenderDeviceVk.h

@@ -75,6 +75,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceVk, IRenderDevice)
     ///                             texture interface will be stored.
     ///                             The function calls AddRef(), so that the new object will contain
     ///                             one reference.
+    ///
     /// \note  Created texture object does not take ownership of the Vulkan image and will not
     ///        destroy it once released. The application must not destroy the image while it is
     ///        in use by the engine.
@@ -95,6 +96,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceVk, IRenderDevice)
     ///                             buffer interface will be stored.
     ///                             The function calls AddRef(), so that the new object will contain
     ///                             one reference.
+    ///
     /// \note  Created buffer object does not take ownership of the Vulkan buffer and will not
     ///        destroy it once released. The application must not destroy Vulkan buffer while it is
     ///        in use by the engine.
@@ -114,6 +116,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceVk, IRenderDevice)
     ///                             bottom-level AS interface will be stored.
     ///                             The function calls AddRef(), so that the new object will contain
     ///                             one reference.
+    ///
     /// \note  Created bottom-level AS object does not take ownership of the Vulkan acceleration structure and will not
     ///        destroy it once released. The application must not destroy Vulkan acceleration structure while it is
     ///        in use by the engine.
@@ -133,6 +136,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceVk, IRenderDevice)
     ///                             top-level AS interface will be stored.
     ///                             The function calls AddRef(), so that the new object will contain
     ///                             one reference.
+    ///
     /// \note  Created top-level AS object does not take ownership of the Vulkan acceleration structure and will not
     ///        destroy it once released. The application must not destroy Vulkan acceleration structure while it is
     ///        in use by the engine.
@@ -150,6 +154,7 @@ DILIGENT_BEGIN_INTERFACE(IRenderDeviceVk, IRenderDevice)
     ///                                    fence interface will be stored.
     ///                                    The function calls AddRef(), so that the new object will contain
     ///                                    one reference.
+    ///
     /// \note  Created fence object does not take ownership of the Vulkan semaphore and will not
     ///        destroy it once released. The application must not destroy Vulkan semaphore while it is
     ///        in use by the engine.

Graphics/GraphicsEngineVulkan/interface/ShaderBindingTableVk.h

@@ -61,7 +61,7 @@ typedef struct BindingTableVk BindingTableVk;
 DILIGENT_BEGIN_INTERFACE(IShaderBindingTableVk, IShaderBindingTable)
 {
     /// Returns the data that can be used with vkCmdTraceRaysKHR() call.
-    ///
+
     /// \remarks  The method is not thread-safe. An application must externally synchronize the access
     ///           to the shader binding table.
     VIRTUAL const BindingTableVk REF METHOD(GetVkBindingTable)(THIS) CONST PURE;

Graphics/GraphicsEngineVulkan/interface/TextureVk.h

@@ -58,6 +58,7 @@ DILIGENT_BEGIN_INTERFACE(ITextureVk, ITexture)
     /// Sets Vulkan image layout
 
     /// \param [in] Layout - Vulkan image layout to set.
+    ///
     /// \note This function does not perform layout transition, but sets the
     ///       internal texture state to match the given Vulkan layout.
     VIRTUAL void METHOD(SetLayout)(THIS_