From 37515eb550a73b935b96187362ca6bf1a7177e6c Mon Sep 17 00:00:00 2001
From: Egor Yusov <egor.yusov@gmail.com>
Date: Fri, 8 Nov 2019 19:00:58 -0800
Subject: Updated descriptions of backend-specific interfaces

---
 Graphics/GraphicsEngineD3D11/interface/BufferD3D11.h                | 2 +-
 Graphics/GraphicsEngineD3D11/interface/BufferViewD3D11.h            | 2 +-
 Graphics/GraphicsEngineD3D11/interface/DeviceContextD3D11.h         | 2 +-
 Graphics/GraphicsEngineD3D11/interface/FenceD3D11.h                 | 2 +-
 Graphics/GraphicsEngineD3D11/interface/PipelineStateD3D11.h         | 2 +-
 Graphics/GraphicsEngineD3D11/interface/RenderDeviceD3D11.h          | 2 +-
 Graphics/GraphicsEngineD3D11/interface/SamplerD3D11.h               | 2 +-
 Graphics/GraphicsEngineD3D11/interface/ShaderD3D11.h                | 2 +-
 Graphics/GraphicsEngineD3D11/interface/ShaderResourceBindingD3D11.h | 2 +-
 Graphics/GraphicsEngineD3D11/interface/SwapChainD3D11.h             | 2 +-
 Graphics/GraphicsEngineD3D11/interface/TextureD3D11.h               | 2 +-
 Graphics/GraphicsEngineD3D11/interface/TextureViewD3D11.h           | 2 +-
 12 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'Graphics/GraphicsEngineD3D11')

diff --git a/Graphics/GraphicsEngineD3D11/interface/BufferD3D11.h b/Graphics/GraphicsEngineD3D11/interface/BufferD3D11.h
index ea23e1b8..81132133 100644
--- a/Graphics/GraphicsEngineD3D11/interface/BufferD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/BufferD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_BufferD3D11 =
 { 0x4a696d2e, 0x44bb, 0x4c4b, { 0x9d, 0xe2, 0x3a, 0xf7, 0xc9, 0x4d, 0xcf, 0xc0 } };
 
-/// Interface to the buffer object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a buffer object.
 class IBufferD3D11 : public IBuffer
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/BufferViewD3D11.h b/Graphics/GraphicsEngineD3D11/interface/BufferViewD3D11.h
index 1a9b15a2..701e5df8 100644
--- a/Graphics/GraphicsEngineD3D11/interface/BufferViewD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/BufferViewD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_BufferViewD3D11 =
 { 0x6aba95fc, 0xcd7d, 0x4c03, { 0x8c, 0xae, 0xaf, 0xc4, 0x5f, 0x96, 0x96, 0xb7 } };
 
-/// Interface to the buffer view object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a buffer view object.
 class IBufferViewD3D11 : public IBufferView
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/DeviceContextD3D11.h b/Graphics/GraphicsEngineD3D11/interface/DeviceContextD3D11.h
index 47ca68c0..948bac58 100644
--- a/Graphics/GraphicsEngineD3D11/interface/DeviceContextD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/DeviceContextD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_DeviceContextD3D11 =
 { 0xf0ee0335, 0xc8ab, 0x4ec1, { 0xbb, 0x15, 0xb8, 0xee, 0x5f, 0x0, 0x3b, 0x99 } };
 
-/// Interface to the device context object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a device context.
 class IDeviceContextD3D11 : public IDeviceContext
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/FenceD3D11.h b/Graphics/GraphicsEngineD3D11/interface/FenceD3D11.h
index c025f8a0..4d88ffdc 100644
--- a/Graphics/GraphicsEngineD3D11/interface/FenceD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/FenceD3D11.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_FenceD3D11 =
 { 0x45f2be28, 0x652b, 0x4180, { 0xb6, 0xe4, 0xe7, 0x5f, 0x83, 0xf6, 0x3c, 0xc7 } };
 
 
-/// Interface to the fence object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a fence object.
 class IFenceD3D11 : public IFence
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/PipelineStateD3D11.h b/Graphics/GraphicsEngineD3D11/interface/PipelineStateD3D11.h
index 052c740f..1f689a86 100644
--- a/Graphics/GraphicsEngineD3D11/interface/PipelineStateD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/PipelineStateD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_PipelineStateD3D11 = 
 { 0x3ea6e3f4, 0x9966, 0x47fc, { 0x8c, 0xe8, 0xe, 0xb3, 0xe2, 0x27, 0x30, 0x61 } };
 
-/// Interface to the blend state object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a pipeline state object.
 class IPipelineStateD3D11 : public IPipelineState
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/RenderDeviceD3D11.h b/Graphics/GraphicsEngineD3D11/interface/RenderDeviceD3D11.h
index 50290a2b..91c70a3a 100644
--- a/Graphics/GraphicsEngineD3D11/interface/RenderDeviceD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/RenderDeviceD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_RenderDeviceD3D11 =
 { 0x5b1cbb8, 0xfcad, 0x49ee, { 0xba, 0xda, 0x78, 0x1, 0x22, 0x3e, 0xc3, 0xfe } };
 
-/// Interface to the render device object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a render device.
 class IRenderDeviceD3D11 : public IRenderDevice
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/SamplerD3D11.h b/Graphics/GraphicsEngineD3D11/interface/SamplerD3D11.h
index 3d955699..9baa298e 100644
--- a/Graphics/GraphicsEngineD3D11/interface/SamplerD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/SamplerD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_SamplerD3D11 =
 { 0x31a3bfaf, 0x738e, 0x4d8c, { 0xad, 0x18, 0xb0, 0x21, 0xc5, 0xd9, 0x48, 0xdd } };
 
-/// Interface to the sampler object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a sampler object.
 class ISamplerD3D11 : public ISampler
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/ShaderD3D11.h b/Graphics/GraphicsEngineD3D11/interface/ShaderD3D11.h
index 17ccbcba..6a7fbc61 100644
--- a/Graphics/GraphicsEngineD3D11/interface/ShaderD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/ShaderD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_ShaderD3D11 =
 { 0xc513e83e, 0xb037, 0x405b, { 0x8b, 0x49, 0xbf, 0x8f, 0x5c, 0x22, 0xd, 0xee } };
 
-/// Interface to the shader object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a shader object.
 class IShaderD3D11 : public IShaderD3D
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/ShaderResourceBindingD3D11.h b/Graphics/GraphicsEngineD3D11/interface/ShaderResourceBindingD3D11.h
index f2a06599..acbcc803 100644
--- a/Graphics/GraphicsEngineD3D11/interface/ShaderResourceBindingD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/ShaderResourceBindingD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_ShaderResourceBindingD3D11 =
 { 0x97a6d4ac, 0xd4af, 0x4aa9, { 0xb4, 0x6c, 0x67, 0x41, 0x7b, 0x89, 0x2, 0x6a } };
 
-/// Shader resource binding interface
+/// Exposes Direct3D11-specific functionality of a shader resource binding object.
 class IShaderResourceBindingD3D11 : public IShaderResourceBinding
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/SwapChainD3D11.h b/Graphics/GraphicsEngineD3D11/interface/SwapChainD3D11.h
index e8439740..fa4d0081 100644
--- a/Graphics/GraphicsEngineD3D11/interface/SwapChainD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/SwapChainD3D11.h
@@ -36,7 +36,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_SwapChainD3D11 =
 { 0x4daf2e76, 0x9204, 0x4dc4, { 0xa5, 0x3a, 0xb0, 0x0, 0x97, 0x41, 0x2d, 0x3a } };
 
-/// Interface to the swap chain object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a swap chain.
 class ISwapChainD3D11 : public ISwapChain
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/TextureD3D11.h b/Graphics/GraphicsEngineD3D11/interface/TextureD3D11.h
index dfc185e8..2861e406 100644
--- a/Graphics/GraphicsEngineD3D11/interface/TextureD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/TextureD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_TextureD3D11 =
 { 0xf3a84cc2, 0xe485, 0x4e72, { 0xa0, 0x8a, 0x43, 0x7d, 0x7f, 0xfb, 0xa3, 0xab } };
 
-/// Interface to the texture object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a texture object.
 class ITextureD3D11 : public ITexture
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D11/interface/TextureViewD3D11.h b/Graphics/GraphicsEngineD3D11/interface/TextureViewD3D11.h
index 4570ee0a..24395b30 100644
--- a/Graphics/GraphicsEngineD3D11/interface/TextureViewD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/TextureViewD3D11.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_TextureViewD3D11 =
 { 0x767ebe4, 0xad47, 0x4e70, { 0x9b, 0x65, 0x38, 0xc6, 0xb9, 0xca, 0xc3, 0x7d } };
 
-/// Interface to the texture view object implemented in D3D11
+/// Exposes Direct3D11-specific functionality of a texture view object.
 class ITextureViewD3D11 : public ITextureView
 {
 public:
-- 
cgit v1.2.3