8000 Add Missing System.Diagnostics docs (#4856) · dotnet/dotnet-api-docs@d26c069 · GitHub
[go: up one dir, main page]
Skip to content

Commit d26c069

Browse files
tarekghcarlossanlop
tarekgh
and
carlossanlop
authored
Add Missing System.Diagnostics docs (#4856)
* Add Missing System.Diagnostics docs * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>
1 parent ea42d46 commit d26c069

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

‎xml/System.Diagnostics/ActivityCreationOptions`1.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ The possible generic type parameters are <see cref="T:System.Diagnostics.Activit
124124
<ReturnType>System.Diagnostics.ActivityTagsCollection</ReturnType>
125125
</ReturnValue>
126126
<Docs>
127-
<summary>To be added.</summary>
128-
<value>To be added.</value>
127+
<summary>Gets the collection that is used to add more tags during the sampling process. The added tags are also added to the created Activity if it is decided that it should be created by the <see cref="T:System.Diagnostics.ActivityListener" /> callbacks.</summary>
128+
<value>The Activity tags collection.</value>
129129
<remarks>To be added.</remarks>
130130
</Docs>
131131
</Member>
@@ -187,9 +187,9 @@ The possible generic type parameters are <see cref="T:System.Diagnostics.Activit
187187
<ReturnType>System.Diagnostics.ActivityTraceId</ReturnType>
188188
</ReturnValue>
189189
<Docs>
190-
<summary>To be added.</summary>
191-
<value>To be added.</value>
192-
<remarks>To be added.</remarks>
190+
<summary>Gets the trace Id to use in the Activity object if it is decided that it should be created by <see cref="T:System.Diagnostics.ActivityListener" /> callbacks.</summary>
191+
<value>The trace Id.</value>
192+
<remarks>If the parent is an <see cref="T:System.Diagnostics.ActivityContext" /> and not equal to the <see langword="default" /> value, then the trace Id inside the parent will be the value returned from this property. If it is equal to the <see langword="default" /> value, a new trace Id will get generated and returned from this property.</remarks>
193193
</Docs>
194194
</Member>
195195
</Members>

‎xml/System.Diagnostics/SampleActivity`1.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
<ReturnType>System.Diagnostics.ActivitySamplingResult</ReturnType>
2323
</ReturnValue>
2424
<Docs>
25-
<typeparam name="T">To be added.</typeparam>
26-
<param name="options">To be added.</param>
27-
<summary>To be added.</summary>
28-
<returns>To be added.</returns>
25+
<typeparam name="T">The type of the requested parent to create the Activity object with. Should be either a string or an <see cref="T:System.Diagnostics.ActivityContext" /> instance.</typeparam>
26+
<param name="options">The Activity creation options used by <see cref="T:System.Diagnostics.ActivityListener" /> callbacks to decide creating the Activity object or not.</param>
27+
<summary>A delegate that defines the signature of the <see cref="T:System.Diagnostics.ActivityListener" /> callbacks used in the sampling process.</summary>
28+
<returns>An object containing the sampling results, which indicate the amount of data to collect for the related <see cref="T:System.Diagnostics.Activity" />.</returns>
2929
<remarks>To be added.</remarks>
3030
</Docs>
3131
</Type>

0 commit comments

Comments
 (0)
0