Skip to content

Port System.Diagnostics new docs #10207

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 1 commit into from
Aug 8, 2024
Merged

Port System.Diagnostics new docs #10207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 15 additions & 5 deletions xml/System.Diagnostics.CodeAnalysis/FeatureGuardAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,15 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>
<para>Indicates that the specified public static boolean get-only property</para>
<para>guards access to the specified feature.</para>
</summary>
<remarks>
<para>Analyzers can use this to prevent warnings on calls to code that is</para>
<para>annotated as requiring that feature, when the callsite is guarded by a</para>
<para>call to the property.</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -48,8 +55,11 @@
<Parameter Name="featureType" Type="System.Type" />
</Parameters>
<Docs>
<param name="featureType">To be added.</param>
<summary>To be added.</summary>
<param name="featureType">The type that represents the feature guarded by the property.</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.FeatureGuardAttribute" /> class</para>
<para>with the specified feature type.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -69,7 +79,7 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The type that represents the feature guarded by the property.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
19 changes: 14 additions & 5 deletions xml/System.Diagnostics.CodeAnalysis/FeatureSwitchDefinitionAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,14 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>
<para>Indicates that the specified public static boolean get-only property</para>
<para>corresponds to the feature switch specified by name.</para>
</summary>
<remarks>
<para>IL rewriters and compilers can use this to substitute the return value</para>
<para>of the specified property with the value of the feature switch.</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -48,8 +54,11 @@
<Parameter Name="switchName" Type="System.String" />
</Parameters>
<Docs>
<param name="switchName">To be added.</param>
<summary>To be added.</summary>
<param name="switchName">The name of the feature switch that provides the value for the specified property.</param>
<summary>
<para>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.FeatureSwitchDefinitionAttribute" /> class</para>
<para>with the specified feature switch name.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -69,7 +78,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The name of the feature switch that provides the value for the specified property.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
4 changes: 4 additions & 0 deletions xml/System.Diagnostics.Contracts/Contract.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,7 @@
<paramref name="predicate" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="toExclusive" /> is less than <paramref name="fromInclusive" />.</exception>
<seealso cref="M:System.Collections.Generic.List`1.Exists(System.Predicate{`0})" />
</Docs>
</Member>
<Member MemberName="Exists&lt;T&gt;">
Expand Down Expand Up @@ -949,6 +950,7 @@
<exception cref="T:System.ArgumentNullException">
<paramref name="collection" /> or <paramref name="predicate" /> is <see langword="null" />.</exception>
<altmember cref="M:System.Collections.Generic.List`1.Exists(System.Predicate{`0})" />
<seealso cref="M:System.Collections.Generic.List`1.Exists(System.Predicate{`0})" />
</Docs>
</Member>
<Member MemberName="ForAll">
Expand Down Expand Up @@ -1022,6 +1024,7 @@
<exception cref="T:System.ArgumentException">
<paramref name="toExclusive" /> is less than <paramref name="fromInclusive" />.</exception>
<altmember cref="M:System.Collections.Generic.List`1.TrueForAll(System.Predicate{`0})" />
<seealso cref="M:System.Collections.Generic.List`1.TrueForAll(System.Predicate{`0})" />
</Docs>
</Member>
<Member MemberName="ForAll&lt;T&gt;">
Expand Down Expand Up @@ -1097,6 +1100,7 @@
<exception cref="T:System.ArgumentNullException">
<paramref name="collection" /> or <paramref name="predicate" /> is <see langword="null" />.</exception>
<altmember cref="M:System.Collections.Generic.List`1.TrueForAll(System.Predicate{`0})" />
<seealso cref="M:System.Collections.Generic.List`1.TrueForAll(System.Predicate{`0})" />
</Docs>
</Member>
<MemberGroup MemberName="Invariant">
Expand Down
28 changes: 19 additions & 9 deletions xml/System.Diagnostics/DiagnosticMethodInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Represents diagnostic information about a method. Information provided by this class is similar to information</para>
<para>provided by <see cref="T:System.Reflection.MethodBase" /> but it's meant for logging and tracing purposes.</para>
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -54,9 +57,12 @@
</Parameters>
<Docs>
<param name="delegate">To be added.</param>
<summary>To be added.</summary>
<summary>Creates a <see cref="T:System.Diagnostics.DiagnosticMethodInfo" /> that represents the target of the delegate.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>This returns the definition of the target method, with stripped instantiation information.</para>
<para>The return value might be <see langword="null" /> if the `StackTraceSupport` feature switch is set to <see langword="false" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Create">
Expand Down Expand Up @@ -85,9 +91,13 @@
</Parameters>
<Docs>
<param name="frame">To be added.</param>
<summary>To be added.</summary>
<summary>Creates a <see cref="T:System.Diagnostics.DiagnosticMethodInfo" /> that represents the method this stack frame is associtated with.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>
<para>This returns the definition of the target method, with stripped instantiation information.</para>
<para>The return value might be <see langword="null" /> if the `StackTraceSupport` feature switch is set to <see langword="false" />.</para>
<para>The return value might be <see langword="null" /> if the target method is unknown.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DeclaringAssemblyName">
Expand All @@ -106,7 +116,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the display name of the assembly that owns this method.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -127,7 +137,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the fully qualified name of the type that owns this method, including its namespace but not its assembly.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -148,9 +158,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the name of the method.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>Only the simple name of the method is returned, without information about generic parameters or arity.</remarks>
</Docs>
</Member>
</Members>
Expand Down