Skip to content

Automatically port System.Diagnostics docs for RC2 #4853

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 3 commits into from
Sep 16, 2020
Merged

Automatically port System.Diagnostics docs for RC2 #4853

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bc31dc
Automatically port System.Diagnostics docs for RC2
carlossanlop Sep 15, 2020
1ecec52
Update xml/System.Diagnostics/ActivitySamplingResult.xml
tarekgh Sep 15, 2020
ac928a5
Update xml/System.Diagnostics/Process.xml
carlossanlop Sep 16, 2020
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
22 changes: 12 additions & 10 deletions xml/System.Diagnostics/ActivityContext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
<Docs>
<param name="traceId">A trace identifier.</param>
<param name="spanId">A span identifier.</param>
<param name="traceFlags">To be added.</param>
<param name="traceFlags">Contain details about the trace.</param>
<param name="traceState">Carries system-specific configuration data.</param>
<param name="isRemote">Indicates if the context is propagated from a remote parent.</param>
<summary>Construct a new activity context instance using the specified arguments.</summary>
Expand Down Expand Up @@ -249,11 +249,12 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
<Parameter Name="traceState" Type="System.String" />
</Parameters>
<Docs>
<param name="traceParent">To be added.</param>
<param name="traceState">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="traceParent">The W3C trace parent header.</param>
<param name="traceState">The trace state.</param>
<summary>Parses a W3C trace context headers to an <see cref="T:System.Diagnostics.ActivityContext" /> object.</summary>
<returns>The <see cref="T:System.Diagnostics.ActivityContext" /> object created from the parsing operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">The trace parent is invalid.</exception>
</Docs>
</Member>
<Member MemberName="SpanId">
Expand Down Expand Up @@ -361,11 +362,12 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
<Parameter Name="context" Type="System.Diagnostics.ActivityContext" RefType="out" />
</Parameters>
<Docs>
<param name="traceParent">To be added.</param>
<param name="traceState">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="traceParent">The W3C trace parent header.</param>
<param name="traceState">The W3C trace state.</param>
<param name="context">When this method returns <see langword="true" />, the <see cref="T:System.Diagnostics.ActivityContext" /> object created from the parsing operation.</param>
<summary>Tries to parse the W3C trace context headers to an <see cref="T:System.Diagnostics.ActivityContext" /> object.</summary>
<returns>
<see langword="true" /> if the parsing was successful; <see langword="false" /> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Diagnostics/ActivityListener.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@
<ReturnType>System.Diagnostics.SampleActivity&lt;System.Diagnostics.ActivityContext&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the callback that is used to decide if creating <see cref="T:System.Diagnostics.Activity" /> objects with a specific data state is allowed.</summary>
<value>A sample activity instance.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -142,8 +142,8 @@
<ReturnType>System.Diagnostics.SampleActivity&lt;System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets the callback that is used to decide if creating <see cref="T:System.Diagnostics.Activity" /> objects with a specific data state is allowed.</summary>
<value>A sample activity instance.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 5 additions & 5 deletions xml/System.Diagnostics/ActivitySamplingResult.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<summary>Enumeration values used by <see cref="T:System.Diagnostics.ActivityListener" /> to indicate the amount of data to collect for the related <see cref="T:System.Diagnostics.Activity" />. Requesting more data causes a greater performance overhead.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,7 +34,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The activity object should be populated with all the propagation information and also all other properties such as Links, Tags, and Events. Using this value causes <see cref="P:System.Diagnostics.Activity.IsAllDataRequested" /> to return <see langword="true" />.</summary>
</Docs>
</Member>
<Member MemberName="AllDataAndRecorded">
Expand All @@ -54,7 +54,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The activity object should be populated the same as the <see cref="F:System.Diagnostics.ActivitySamplingResult.AllData" /> case. Additionally, Activity.Recorded is set to <see langword="true" />. For activities using the W3C trace ids, this sets a flag bit in the ID that will be propagated downstream requesting that the trace is recorded everywhere.</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand All @@ -74,7 +74,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The activity object does not need to be created.</summary>
</Docs>
</Member>
<Member MemberName="PropagationData">
Expand All @@ -94,7 +94,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The activity object needs to be created. It will have a Name, a Source, an Id and Baggage. Other properties are unnecessary and will be ignored by this listener.</summary>
</Docs>
</Member>
</Members>
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Diagnostics/Process.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5230,10 +5230,10 @@ The file specified in the <paramref name="fileName" /> could not be found.</exce
<Parameter Name="arguments" Type="System.Collections.Generic.IEnumerable&lt;System.String&gt;" Index="1" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="fileName">To be added.</param>
<param name="arguments">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="fileName">The name of a document or application file to run in the process.</param>
Copy link
Contributor Author

@carlossanlop carlossanlop Sep 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamsitnik @eiriktsarpalis since you own Diagnostics.Process, can you review this file please?

<param name="arguments">The command line arguments.</param>
<summary>Starts a process resource by specifying the name of an application and a set of command line arguments.</summary>
<returns>A new <see cref="T:System.Diagnostics.Process" /> that is associated with the process resource, or <see langword="null" /> if no process resource is started.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down