docs: add DefaultTraceListener entry to trace listeners table #50120
+3
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### Summary Added the missing `DefaultTraceListener` entry to the trace listeners table in the `.NET Framework` configuration documentation. ### Why The table listing available trace listener classes did not include `DefaultTraceListener`, which caused confusion for users trying to configure it using `app.config`. This listener is automatically included by default in the `Trace.Listeners` collection, but users may want to reference it explicitly in configuration files. ### Change - Added a new row for `DefaultTraceListener` to the trace listener table in `add-element-for-listeners-for-trace.md`. - Clarified its purpose and default behavior in debugging and tracing scenarios. ### Related Issue Fixes dotnet#48559
dotnet-policy-service
bot
added
dotnet-framework/svc
community-contribution
Contributor
Author
|
Hi @dotnet/docs team Kindly requesting a quick review when you get a chance Thanks for your time and all the great documentation work you do |
Contributor
Author
|
Hi @gewarren, |
| |<xref:System.Diagnostics.TextWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.TextWriterTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.| | ||
| |xref:System.Diagnostics.DefaultTraceListener?displayProperty=nameWithType|The default trace listener that outputs messages to the Visual Studio Output window or debugger. This listener is automatically included in the `Trace.Listeners` collection unless explicitly removed in the configuration.| |
There was a problem hiding this comment.
I assume the new xref link should have < > around it like the existing ones have.
| |<xref:System.Diagnostics.TextWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.TextWriterTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.| | ||
| |xref:System.Diagnostics.DefaultTraceListener?displayProperty=nameWithType|The default trace listener that outputs messages to the Visual Studio Output window or debugger. This listener is automatically included in the `Trace.Listeners` collection unless explicitly removed in the configuration.| |
There was a problem hiding this comment.
The second column of this table is "initializeData attribute value", but DefaultTraceListener does not support initializeData. Instead of describing the purpose of DefaultTraceListener, the new row should state that initializeData is not used with that type of listener.
| |<xref:System.Diagnostics.EventSchemaTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.EventSchemaTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.TextWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.TextWriterTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.| | ||
| |<xref:System.Diagnostics.XmlWriterTraceListener?displayProperty=nameWithType>|The name of the file that the <xref:System.Diagnostics.XmlWriterTraceListener> writes to.| |
There was a problem hiding this comment.
There is another similar table here:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added the missing
DefaultTraceListenerentry to the trace listeners table in the.NET Frameworkconfiguration documentation.Why
The table listing available trace listener classes did not include
DefaultTraceListener, which caused confusion for users trying to configure it usingapp.config. This listener is automatically included by default in theTrace.Listenerscollection, but users may want to reference it explicitly in configuration files.Change
DefaultTraceListenerto the trace listener table inadd-element-for-listeners-for-trace.md.Related Issue
Fixes #48559
Summary
Describe your changes here.
Fixes #Issue_Number (if available)
Internal previews