Skip to content
This repository was archived by the owner on Mar 30, 2019. It is now read-only.

Commit efb5f91

Browse files
committed
[Doc] Fix documentation comments on function reflection. Add comment for return parameter
1 parent 3c36eb9 commit efb5f91

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

Source/SharpDX.D3DCompiler/FunctionReflection.cs

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ public FunctionParameterReflection[] Parameters
5858
}
5959
}
6060

61+
/// <summary>
62+
/// Returns reflection for function return parameter
63+
/// </summary>
64+
/// <exception cref="System.ArgumentException">Thrown if function has no return value (void)</exception>
6165
public FunctionParameterReflection ReturnParameter
6266
{
6367
get
@@ -74,11 +78,11 @@ public FunctionParameterReflection ReturnParameter
7478
/// <p>Gets a description of how a resource is bound to a function. </p>
7579
/// </summary>
7680
/// <param name="resourceIndex"><dd> <p>A zero-based resource index.</p> </dd></param>
77-
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p> </dd></returns>
81+
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p></returns>
7882
/// <remarks>
7983
/// <p>A shader consists of executable code (the compiled HLSL functions) and a set of resources that supply the shader with input data. <strong>GetResourceBindingDesc</strong> gets info about how one resource in the set is bound as an input to the shader. The <em>ResourceIndex</em> parameter specifies the index for the resource.</p>
8084
/// </remarks>
81-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
85+
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
8286
/// <msdn-id>dn280551</msdn-id>
8387
/// <unmanaged>HRESULT ID3D11FunctionReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc)</unmanaged>
8488
/// <unmanaged-short>ID3D11FunctionReflection::GetResourceBindingDesc</unmanaged-short>
@@ -93,11 +97,11 @@ public InputBindingDescription GetResourceBindingDescription(int index)
9397
/// <p>Gets a description of how a resource is bound to a function. </p>
9498
/// </summary>
9599
/// <param name="name"><dd> <p>Resource name.</p> </dd></param>
96-
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p> </dd></returns>
100+
/// <returns><p>A reference to a <strong><see cref="SharpDX.D3DCompiler.InputBindingDescription"/></strong> structure that describes input binding of the resource. </p></returns>
97101
/// <remarks>
98102
/// <p>A shader consists of executable code (the compiled HLSL functions) and a set of resources that supply the shader with input data. <strong>GetResourceBindingDesc</strong> gets info about how one resource in the set is bound as an input to the shader. The <em>ResourceIndex</em> parameter specifies the index for the resource.</p>
99103
/// </remarks>
100-
/// <include file='.\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
104+
/// <include file='..\..\Documentation\CodeComments.xml' path="/comments/comment[@id='ID3D11FunctionReflection::GetResourceBindingDesc']/*"/>
101105
/// <msdn-id>dn280551</msdn-id>
102106
/// <unmanaged>HRESULT ID3D11FunctionReflection::GetResourceBindingDesc([In] unsigned int ResourceIndex,[Out] D3D11_SHADER_INPUT_BIND_DESC* pDesc)</unmanaged>
103107
/// <unmanaged-short>ID3D11FunctionReflection::GetResourceBindingDesc</unmanaged-short>

0 commit comments

Comments
 (0)