Skip to content

Commit 5825ea0

Browse files
carlossanloptarekgh
authored andcommitted
Automatically port System.Diagnostics docs for RC2 (dotnet#4853)
* Automatically port System.Diagnostics docs for RC2 * Update xml/System.Diagnostics/ActivitySamplingResult.xml Co-authored-by: Carlos Sanchez <[email protected]> * Update xml/System.Diagnostics/Process.xml Co-authored-by: carlossanlop <[email protected]> Co-authored-by: Tarek Mahmoud Sayed <[email protected]>
1 parent 7fa415c commit 5825ea0

File tree

4 files changed

+25
-23
lines changed

4 files changed

+25
-23
lines changed

xml/System.Diagnostics/ActivityContext.xml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
5151
<Docs>
5252
<param name="traceId">A trace identifier.</param>
5353
<param name="spanId">A span identifier.</param>
54-
<param name="traceFlags">To be added.</param>
54+
<param name="traceFlags">Contain details about the trace.</param>
5555
<param name="traceState">Carries system-specific configuration data.</param>
5656
<param name="isRemote">Indicates if the context is propagated from a remote parent.</param>
5757
<summary>Construct a new activity context instance using the specified arguments.</summary>
@@ -249,11 +249,12 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
249249
<Parameter Name="traceState" Type="System.String" />
250250
</Parameters>
251251
<Docs>
252-
<param name="traceParent">To be added.</param>
253-
<param name="traceState">To be added.</param>
254-
<summary>To be added.</summary>
255-
<returns>To be added.</returns>
252+
<param name="traceParent">The W3C trace parent header.</param>
253+
<param name="traceState">The trace state.</param>
254+
<summary>Parses a W3C trace context headers to an <see cref="T:System.Diagnostics.ActivityContext" /> object.</summary>
255+
<returns>The <see cref="T:System.Diagnostics.ActivityContext" /> object created from the parsing operation.</returns>
256256
<remarks>To be added.</remarks>
257+
<exception cref="T:System.ArgumentException">The trace parent is invalid.</exception>
257258
</Docs>
258259
</Member>
259260
<Member MemberName="SpanId">
@@ -361,11 +362,12 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
361362
<Parameter Name="context" Type="System.Diagnostics.ActivityContext" RefType="out" />
362363
</Parameters>
363364
<Docs>
364-
<param name="traceParent">To be added.</param>
365-
<param name="traceState">To be added.</param>
366-
<param name="context">To be added.</param>
367-
<summary>To be added.</summary>
368-
<returns>To be added.</returns>
365+
<param name="traceParent">The W3C trace parent header.</param>
366+
<param name="traceState">The W3C trace state.</param>
367+
<param name="context">When this method returns <see langword="true" />, the <see cref="T:System.Diagnostics.ActivityContext" /> object created from the parsing operation.</param>
368+
<summary>Tries to parse the W3C trace context headers to an <see cref="T:System.Diagnostics.ActivityContext" /> object.</summary>
369+
<returns>
370+
<see langword="true" /> if the parsing was successful; <see langword="false" /> otherwise.</returns>
369371
<remarks>To be added.</remarks>
370372
</Docs>
371373
</Member>

xml/System.Diagnostics/ActivityListener.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@
121121
<ReturnType>System.Diagnostics.SampleActivity&lt;System.Diagnostics.ActivityContext&gt;</ReturnType>
122122
</ReturnValue>
123123
<Docs>
124-
<summary>To be added.</summary>
125-
<value>To be added.</value>
124+
<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>
125+
<value>A sample activity instance.</value>
126126
<remarks>To be added.</remarks>
127127
</Docs>
128128
</Member>
@@ -142,8 +142,8 @@
142142
<ReturnType>System.Diagnostics.SampleActivity&lt;System.String&gt;</ReturnType>
143143
</ReturnValue>
144144
<Docs>
145-
<summary>To be added.</summary>
146-
<value>To be added.</value>
145+
<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>
146+
<value>A sample activity instance.</value>
147147
<remarks>To be added.</remarks>
148148
</Docs>
149149
</Member>

xml/System.Diagnostics/ActivitySamplingResult.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<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>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,7 +34,7 @@
3434
</ReturnValue>
3535
<MemberValue>2</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<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>
3838
</Docs>
3939
</Member>
4040
<Member MemberName="AllDataAndRecorded">
@@ -54,7 +54,7 @@
5454
</ReturnValue>
5555
<MemberValue>3</MemberValue>
5656
<Docs>
57-
<summary>To be added.</summary>
57+
<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>
5858
</Docs>
5959
</Member>
6060
<Member MemberName="None">
@@ -74,7 +74,7 @@
7474
</ReturnValue>
7575
<MemberValue>0</MemberValue>
7676
<Docs>
77-
<summary>To be added.</summary>
77+
<summary>The activity object does not need to be created.</summary>
7878
</Docs>
7979
</Member>
8080
<Member MemberName="PropagationData">
@@ -94,7 +94,7 @@
9494
</ReturnValue>
9595
<MemberValue>1</MemberValue>
9696
<Docs>
97-
<summary>To be added.</summary>
97+
<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>
9898
</Docs>
9999
</Member>
100100
</Members>

xml/System.Diagnostics/Process.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5230,10 +5230,10 @@ The file specified in the <paramref name="fileName" /> could not be found.</exce
52305230
<Parameter Name="arguments" Type="System.Collections.Generic.IEnumerable&lt;System.String&gt;" Index="1" FrameworkAlternate="net-5.0" />
52315231
</Parameters>
52325232
<Docs>
5233-
<param name="fileName">To be added.</param>
5234-
<param name="arguments">To be added.</param>
5235-
<summary>To be added.</summary>
5236-
<returns>To be added.</returns>
5233+
<param name="fileName">The name of a document or application file to run in the process.</param>
5234+
<param name="arguments">The command-line arguments to pass when starting the process.</param>
5235+
<summary>Starts a process resource by specifying the name of an application and a set of command line arguments.</summary>
5236+
<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>
52375237
<remarks>To be added.</remarks>
52385238
</Docs>
52395239
</Member>

0 commit comments

Comments
 (0)