Remove .NET Framework remarks (System.Diagnostics)#12644
Conversation
|
@gewarren - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates in the /// comments in the dotnet/runtime repo (or dotnet/extensions repo) instead. |
There was a problem hiding this comment.
Pull request overview
This PR updates the .NET API reference XML docs in System.Diagnostics* to remove .NET Framework-specific remarks (CAS, app.config configuration examples, AppDomain-era notes, and framework-only guidance), aligning this repo with the split of .NET Framework reference docs into dotnetfw-api-docs.
Changes:
- Removed .NET Framework-specific configuration-file guidance and other legacy remarks across tracing/debugging types.
- Simplified and modernized remarks/notes (including some wording and formatting updates to tables and markdown).
- Trimmed .NET Framework/CAS-related cross-references and repeated guidance in performance counter and event log docs.
Reviewed changes
Copilot reviewed 42 out of 42 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Diagnostics/XmlWriterTraceListener.xml | Removes .NET Framework permission/config guidance; cleans up remarks and markdown tables. |
| xml/System.Diagnostics/TraceSwitch.xml | Removes configuration-based usage guidance; updates remarks language. |
| xml/System.Diagnostics/TraceSource.xml | Removes .NET Framework config-file example and related framework-only links. |
| xml/System.Diagnostics/TraceOptions.xml | Removes .NET Framework config-file example and links. |
| xml/System.Diagnostics/TraceListener.xml | Removes compiler/config-file guidance and framework-only related links. |
| xml/System.Diagnostics/TraceLevel.xml | Removes configuration-file mapping guidance and compiler flag details. |
| xml/System.Diagnostics/Trace.xml | Removes .NET Framework config/CAS notes and related framework-only guidance. |
| xml/System.Diagnostics/TextWriterTraceListener.xml | Removes compiler/config-file guidance. |
| xml/System.Diagnostics/Switch.xml | Removes .NET Framework config-file guidance. |
| xml/System.Diagnostics/StackFrameExtensions.xml | Adjusts return text to remove “.NET Framework” phrasing style inconsistencies. |
| xml/System.Diagnostics/SourceSwitch.xml | Removes .NET Framework configuration-file examples/notes. |
| xml/System.Diagnostics/ProcessThread.xml | Removes .NET Framework version-specific note about behavior changes. |
| xml/System.Diagnostics/ProcessStartInfo.xml | Removes CAS/link-demand note; modernizes cross-platform wording; updates framework mentions. |
| xml/System.Diagnostics/Process.xml | Removes .NET Framework vs .NET Core split notes; consolidates encoding guidance. |
| xml/System.Diagnostics/PresentationTraceSources.xml | Removes .NET Framework full-trust/config-file setup guidance; simplifies tracing enablement text. |
| xml/System.Diagnostics/PresentationTraceLevel.xml | Removes .NET Framework introduction note; keeps examples. |
| xml/System.Diagnostics/PerformanceCounterPermissionEntry.xml | Removes CAS remarks/seealso links; normalizes formatting. |
| xml/System.Diagnostics/PerformanceCounterPermissionAttribute.xml | Trims framework-era “attributes” link line; keeps CAS-deprecated include. |
| xml/System.Diagnostics/PerformanceCounterCategoryType.xml | Rewrites remarks to remove .NET Framework version history. |
| xml/System.Diagnostics/PerformanceCounterCategory.xml | Removes Machine.config dependency note; modernizes Windows/UAC guidance. |
| xml/System.Diagnostics/PerformanceCounter.xml | Removes detailed .NET Framework/CAS/IDisposable guidance; simplifies remarks and Windows/UAC notes. |
| xml/System.Diagnostics/FileVersionInfo.xml | Removes .NET Framework full-trust/link-demand note. |
| xml/System.Diagnostics/EventTypeFilter.xml | Removes configuration-file initialization example and framework links. |
| xml/System.Diagnostics/EventLogTraceListener.xml | Removes app.config example; modernizes Windows admin/UAC guidance. |
| xml/System.Diagnostics/EventLogPermissionEntry.xml | Removes CAS “Code Access Security” link; normalizes formatting. |
| xml/System.Diagnostics/EventLogPermissionAttribute.xml | Trims framework-era “attributes” link line; keeps CAS-deprecated include. |
| xml/System.Diagnostics/EventLogPermission.xml | Removes partial-trust and Windows Vista/UAC guidance from remarks. |
| xml/System.Diagnostics/EventLog.xml | Removes partial-trust/CAS guidance; modernizes Windows/UAC notes; normalizes markdown. |
| xml/System.Diagnostics/DelimitedListTraceListener.xml | Removes .NET Framework config examples; simplifies delimiter remarks. |
| xml/System.Diagnostics/DefaultTraceListener.xml | Removes app.config guidance and compiler flag explanation; keeps core listener behavior notes. |
| xml/System.Diagnostics/DebuggerBrowsableAttribute.xml | Removes VB/.NET Framework-specific note; reformats list in remarks. |
| xml/System.Diagnostics/Debugger.xml | Removes .NET Framework 4 WER warning wording; reframes guidance and improves formatting. |
| xml/System.Diagnostics/DebuggableAttribute+DebuggingModes.xml | Removes .NET Framework version history; rewrites remarks/table with modern wording. |
| xml/System.Diagnostics/DebuggableAttribute.xml | Removes .NET Framework version-specific statements; simplifies JIT tracking remark. |
| xml/System.Diagnostics/Debug.xml | Removes .NET Framework config/assert configuration guidance; keeps core behavior notes. |
| xml/System.Diagnostics/ConsoleTraceListener.xml | Removes compiler/config-file guidance; adjusts IDisposable wording. |
| xml/System.Diagnostics/BooleanSwitch.xml | Removes .NET Framework config-file guidance; simplifies remarks and defaults language. |
| xml/System.Diagnostics.Tracing/EventWrittenEventArgs.xml | Removes “.NET Core 2.2+ only” qualifiers from member summaries. |
| xml/System.Diagnostics.Tracing/EventListener.xml | Removes AppDomain scoping language; adjusts IDisposable guidance and generalizes remarks. |
| xml/System.Diagnostics.PerformanceData/CounterData.xml | Removes .NET Framework version-specific thread-safety note; trims example section. |
| xml/System.Diagnostics.Contracts/ContractFailedEventArgs.xml | Removes “full trust” requirement from remarks. |
| xml/System.Diagnostics.Contracts/Contract.xml | Removes “.NET Framework class library” phrasing from remarks. |
Comments suppressed due to low confidence (2)
xml/System.Diagnostics/BooleanSwitch.xml:74
- The sentence ends without punctuation. Add a period to keep the surrounding remarks grammatically consistent.
For more information on instrumenting your application, see <xref:System.Diagnostics.Debug> and <xref:System.Diagnostics.Trace>
xml/System.Diagnostics/ConsoleTraceListener.xml:38
- There’s a missing space before the inline code span: “in a
try/catchblock” should be “in atry/catchblock”.
> This type implements the <xref:System.IDisposable> interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its <xref:System.IDisposable.Dispose*> method in a`try`/`catch` block. To dispose of it indirectly, use a language construct such as `using` in C#.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
.NET Framework API ref has moved to its own repo (https://github.com/dotnet/dotnetfw-api-docs), so we can clean up .NET Framework remarks, exceptions, and code examples out of this repo. Contributes to #12513.
Removes remarks related to:
Also removes repetitive detailed info about enabling tracing.
Hide whitespace changes