Skip to content

Add InlineArrayAttribute docs #9600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Add InlineArrayAttribute docs #9600

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbb8ff0
add inlinearrayattribute docs
gewarren Feb 9, 2024
4edf6a3
fix cref
gewarren Feb 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions xml/System.Runtime.CompilerServices/InlineArrayAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,16 @@
</Attributes>
<Docs>
<summary>Indicates that the instance's storage is sequentially replicated <see cref="P:System.Runtime.CompilerServices.InlineArrayAttribute.Length" /> times.</summary>
<remarks>To be added.</remarks>
<remarks>This attribute can be used to annotate a <see langword="struct"/> type with a single field. The runtime replicates that field in the actual type layout as many times as is specified.</remarks>
<example>The following example shows how to declare an inline array type with eight <see langword="float"/> values.
<code lang="csharp">
[InlineArray(8)]
struct Float8InlineArray
{
private float _value;
}
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -44,8 +53,8 @@
<Parameter Name="length" Type="System.Int32" />
</Parameters>
<Docs>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<param name="length">The number of sequential fields to replicate in the inline array type.</param>
<summary>Creates a new <see cref="T:System.Runtime.CompilerServices.InlineArrayAttribute" /> instance with the specified length.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -65,8 +74,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the number of sequential fields to replicate in the inline array type.</summary>
<value>The number of sequential fields to replicate in the inline array type.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down