Updated documentation for Direct3D12 backend interfaces

Author: TheMostDiligent

Graphics/Archiver/interface/Archiver.h

@@ -169,7 +169,7 @@ DILIGENT_BEGIN_INTERFACE(IArchiver, IObject)
     /// \param [in] ShaderName - Name of the shader object to retrieve.
     /// \return     A pointer to the shader object, or null if the object with that name was not added.
     ///
-    /// \note       The method does *not* increment the reference counter of the returned object,
+    /// \note       The method does **NOT** increment the reference counter of the returned object,
     ///             so the application **must not** call Release() unless it also explicitly calls AddRef().
     VIRTUAL IShader* METHOD(GetShader)(THIS_
                                        const char* ShaderName) PURE;
@@ -180,7 +180,7 @@ DILIGENT_BEGIN_INTERFACE(IArchiver, IObject)
     /// \param [in] PSOName - Name of the pipeline state to retrieve.
     /// \return     A pointer to the pipeline state object, or null if the object with that name was not added.
     ///
-    /// \note       The method does *not* increment the reference counter of the returned object,
+    /// \note       The method does **NOT** increment the reference counter of the returned object,
     ///             so the application **must not** call Release() unless it also explicitly calls AddRef().
     VIRTUAL IPipelineState* METHOD(GetPipelineState)(THIS_
                                                      PIPELINE_TYPE PSOType,
@@ -191,7 +191,7 @@ DILIGENT_BEGIN_INTERFACE(IArchiver, IObject)
     /// \param [in] PRSName - Name of the pipeline resource signature to retrieve.
     /// \return     A pointer to the the pipeline resource signature object, or null if the object with that name was not added.
     ///
-    /// \note      The method does *not* increment the reference counter of the returned object,
+    /// \note      The method does **NOT** increment the reference counter of the returned object,
     ///             so the application **must not** call Release() unless it also explicitly calls AddRef().
     VIRTUAL IPipelineResourceSignature* METHOD(GetPipelineResourceSignature)(THIS_
                                                                              const char* PRSName) PURE;

Graphics/GraphicsEngine/interface/BufferView.h

@@ -164,7 +164,7 @@ DILIGENT_BEGIN_INTERFACE(IBufferView, IDeviceObject)
 
     /// Returns pointer to the referenced buffer object.
 
-    /// The method does *NOT* increment the reference counter of the returned object,
+    /// The method does **NOT** increment the reference counter of the returned object,
     /// so Release() **must not** be called.
     VIRTUAL struct IBuffer* METHOD(GetBuffer)(THIS) CONST PURE;
 };

Graphics/GraphicsEngine/interface/ShaderResourceBinding.h

@@ -60,8 +60,8 @@ DILIGENT_BEGIN_INTERFACE(IShaderResourceBinding, IObject)
     /// Returns a pointer to the pipeline resource signature object that
     /// defines the layout of this shader resource binding object.
 
-    /// The method does *NOT* increment the reference counter of the returned object,
-    /// so Release() must not be called.
+    /// The method does **NOT** increment the reference counter of the returned object,
+    /// so Release() **must not** be called.
     VIRTUAL struct IPipelineResourceSignature* METHOD(GetPipelineResourceSignature)(THIS) CONST PURE;
 
 

Graphics/GraphicsEngineD3D12/interface/BottomLevelASD3D12.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");
@@ -51,10 +51,10 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_BottomLevelASD3D12 =
 /// Exposes Direct3D12-specific functionality of a bottom-level acceleration structure object.
 DILIGENT_BEGIN_INTERFACE(IBottomLevelASD3D12, IBottomLevelAS)
 {
-    /// Returns ID3D12Resource interface of the internal D3D12 acceleration structure object.
+    /// Returns `ID3D12Resource` interface of the internal D3D12 acceleration structure object.
 
-    /// The method does *NOT* increment the reference counter of the returned object,
-    /// so Release() must not be called.
+    /// The method does **NOT** increment the reference counter of the returned object,
+    /// so Release() **must not** be called.
     VIRTUAL ID3D12Resource* METHOD(GetD3D12BLAS)(THIS) PURE;
 };
 DILIGENT_END_INTERFACE

Graphics/GraphicsEngineD3D12/interface/BufferD3D12.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");
@@ -51,15 +51,16 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_BufferD3D12 =
 /// Exposes Direct3D12-specific functionality of a buffer object.
 DILIGENT_BEGIN_INTERFACE(IBufferD3D12, IBuffer)
 {
-    /// Returns a pointer to the ID3D12Resource interface of the internal Direct3D12 object.
+    /// Returns a pointer to the `ID3D12Resource` interface of the internal Direct3D12 object.
 
-    /// The method does *NOT* increment the reference counter of the returned object,
-    /// so Release() must not be called.
     /// \param [in] DataStartByteOffset - Offset from the beginning of the buffer
     ///                            to the start of the data. This parameter
     ///                            is required for dynamic buffers, which are
     ///                            suballocated in a dynamic upload heap
     /// \param [in] pContext - Device context within which address of the buffer is requested.
+    ///
+    /// The method does **NOT** increment the reference counter of the returned object,
+    /// so Release() **must not** be called.
     VIRTUAL ID3D12Resource* METHOD(GetD3D12Buffer)(THIS_
                                                    Uint64 REF      DataStartByteOffset,
                                                    IDeviceContext* pContext) PURE;
@@ -71,8 +72,9 @@ DILIGENT_BEGIN_INTERFACE(IBufferD3D12, IBuffer)
                                                D3D12_RESOURCE_STATES state) PURE;
 
     /// Returns current D3D12 buffer state.
+
     /// If the state is unknown to the engine (Diligent::RESOURCE_STATE_UNKNOWN),
-    /// returns D3D12_RESOURCE_STATE_COMMON (0).
+    /// returns `D3D12_RESOURCE_STATE_COMMON` (0).
     VIRTUAL D3D12_RESOURCE_STATES METHOD(GetD3D12ResourceState)(THIS) CONST PURE;
 };
 DILIGENT_END_INTERFACE

Graphics/GraphicsEngineD3D12/interface/CommandQueueD3D12.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");
@@ -57,11 +57,13 @@ struct ResourceTileMappingsD3D12
     UINT                                   NumResourceRegions              DEFAULT_INITIALIZER(0);
 
     /// An array of structures that describe the starting coordinates of the reserved resource regions.
-    /// The NumResourceRegions parameter specifies the number of elements in the array.
+    
+    /// The `NumResourceRegions` parameter specifies the number of elements in the array.
     const D3D12_TILED_RESOURCE_COORDINATE* pResourceRegionStartCoordinates DEFAULT_INITIALIZER(nullptr);
 
     /// An array of structures that describe the sizes of the reserved resource regions. 
-    /// The NumResourceRegions parameter specifies the number of elements in the array.
+
+    /// The `NumResourceRegions` parameter specifies the number of elements in the array.
     const D3D12_TILE_REGION_SIZE*          pResourceRegionSizes            DEFAULT_INITIALIZER(nullptr);
 
     /// A pointer to the resource heap.
@@ -70,7 +72,8 @@ struct ResourceTileMappingsD3D12
     /// The number of tile ranges.
     UINT                                   NumRanges                       DEFAULT_INITIALIZER(0);
 
-    /// A pointer to an array of D3D12_TILE_RANGE_FLAGS values that describes each tile range.
+    /// A pointer to an array of `D3D12_TILE_RANGE_FLAGS` values that describes each tile range.
+
     /// The NumRanges parameter specifies the number of values in the array.
     const D3D12_TILE_RANGE_FLAGS*          pRangeFlags                     DEFAULT_INITIALIZER(nullptr);
 

Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.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");
@@ -71,19 +71,19 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContextD3D12, IDeviceContext)
 
     /// \return - a pointer to the current command list
     ///
-    /// \remarks  Any command on the device context may potentially submit the command list for
-    ///           execution into the command queue and make it invalid. An application should
-    ///           never cache the pointer and should instead request the command list every time it
-    ///           needs it.
+    /// Any command on the device context may potentially submit the command list for
+    /// execution into the command queue and make it invalid. An application should
+    /// never cache the pointer and should instead request the command list every time it
+    /// needs it.
     ///
-    ///           The engine manages the lifetimes of all command buffers, so an application must
-    ///           not call AddRef/Release methods on the returned interface.
+    /// The engine manages the lifetimes of all command buffers, so an application must
+    /// not call AddRef/Release methods on the returned interface.
     ///
-    ///           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 list, 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 list, 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 ID3D12GraphicsCommandList* METHOD(GetD3D12CommandList)(THIS) PURE;
 };
 DILIGENT_END_INTERFACE

Graphics/GraphicsEngineD3D12/interface/DeviceMemoryD3D12.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.
@@ -49,13 +49,14 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_DeviceMemoryD3D12 =
 /// This structure is returned by IDeviceMemoryD3D12::GetRange()
 struct DeviceMemoryRangeD3D12
 {
-    /// Pointer to the ID3D12Heap interface.
+    /// Pointer to the `ID3D12Heap` interface.
     ID3D12Heap* pHandle  DEFAULT_INITIALIZER(nullptr);
 
     /// Offset from the beginning of the heap to the start of the range, in bytes.
     Uint64      Offset   DEFAULT_INITIALIZER(0);
 
     /// Memory range size in bytes.
+
     /// When IDeviceMemoryD3D12::GetRange() succeeds, the size is equal to the Size argument
     /// that was given to the function, and zero otherwise.
     Uint64      Size     DEFAULT_INITIALIZER(0);

Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.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");
@@ -64,11 +64,11 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
     /// \param [in] DllName - D3D12 dll name.
     /// \return               true if the library and entry points are loaded successfully and false otherwise.
     ///
-    /// \remarks IEngineFactoryD3D12::CreateDeviceAndContextsD3D12() and
-    ///          IEngineFactoryD3D12::AttachToD3D12Device() functions will automatically
-    ///          load the DLL if it has not be loaded already.
+    /// IEngineFactoryD3D12::CreateDeviceAndContextsD3D12() and
+    /// IEngineFactoryD3D12::AttachToD3D12Device() functions will automatically
+    /// load the DLL if it has not be loaded already.
     ///
-    ///          This method has no effect on UWP.
+    /// This method has no effect on UWP.
     VIRTUAL Bool METHOD(LoadD3D12)(THIS_
                                    const char* DllName DEFAULT_VALUE("d3d12.dll")) PURE;
 
@@ -79,7 +79,7 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
     ///                           the created device will be written.
     /// \param [out] ppContexts - Address of the memory location where pointers to
     ///                           the contexts will be written. Immediate context goes at
-    ///                           position 0. If EngineCI.NumDeferredContexts > 0,
+    ///                           position 0. If `EngineCI.NumDeferredContexts > 0`,
     ///                           pointers to the deferred contexts are written afterwards.
     VIRTUAL void METHOD(CreateDeviceAndContextsD3D12)(THIS_
                                                       const EngineD3D12CreateInfo REF EngineCI,
@@ -110,7 +110,7 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
     ///                                  the created device will be written
     /// \param [out] ppContexts - Address of the memory location where pointers to
     ///                           the contexts will be written. Immediate context goes at
-    ///                           position 0. If EngineCI.NumDeferredContexts > 0,
+    ///                           position 0. If `EngineCI.NumDeferredContexts > 0`,
     ///                           pointers to the deferred contexts are written afterwards.
     VIRTUAL void METHOD(AttachToD3D12Device)(THIS_
                                              void*                           pd3d12NativeDevice,
@@ -130,9 +130,9 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
     /// \param [in] FSDesc            - Fullscreen mode description.
     /// \param [in] Window            - Platform-specific native window description that
     ///                                 the swap chain will be associated with:
-    ///                                 * On Win32 platform, this is the window handle (HWND)
+    ///                                 * On Win32 platform, this is the window handle (`HWND`)
     ///                                 * On Universal Windows Platform, this is the reference
-    ///                                   to the core window (Windows::UI::Core::CoreWindow)
+    ///                                   to the core window (`Windows::UI::Core::CoreWindow`)
     ///
     /// \param [out] ppSwapChain    - Address of the memory location where pointer to the new
     ///                               swap chain will be written

Graphics/GraphicsEngineD3D12/interface/FenceD3D12.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");
@@ -50,10 +50,10 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_FenceD3D12 =
 /// Exposes Direct3D12-specific functionality of a fence object.
 DILIGENT_BEGIN_INTERFACE(IFenceD3D12, IFence)
 {
-    /// Returns a pointer to the ID3D12Fence interface of the internal Direct3D12 object.
+    /// Returns a pointer to the `ID3D12Fence` interface of the internal Direct3D12 object.
 
-    /// The method does *NOT* increment the reference counter of the returned object,
-    /// so Release() must not be called.
+    /// The method does **NOT** increment the reference counter of the returned object,
+    /// so Release() **must not** be called.
     VIRTUAL ID3D12Fence* METHOD(GetD3D12Fence)(THIS) PURE;
 };
 DILIGENT_END_INTERFACE