Remove .NET Framework remarks (System.Xml and System.Xaml)#12650
Open
gewarren wants to merge 2 commits into
Open
Remove .NET Framework remarks (System.Xml and System.Xaml)#12650gewarren wants to merge 2 commits into
gewarren wants to merge 2 commits into
Conversation
github-actions
Bot
added
the
area-Meta
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes .NET Framework-specific remarks, examples, and security/app-domain/configuration guidance from the XML API reference files in this repo, aligning the content with the split of .NET Framework docs into a separate repository.
Changes:
- Rewords many references from “.NET Framework” to “.NET” and removes .NET Framework-only guidance (CAS/partial trust, app.config, AppDomain notes).
- Deletes or simplifies remarks/blocks/exceptions that were tied specifically to .NET Framework behavior and versions.
- Replaces some legacy remarks on obsolete APIs with placeholders, and adjusts various parameter/remarks text for modern .NET wording.
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.Xml/XmlWriter.xml | Updates framework-specific notes and parameter docs. |
| xml/System.Xml/XmlValidatingReader.xml | Removes legacy remarks and updates obsolete-type docs (currently contains unresolved merge markers). |
| xml/System.Xml/XmlUrlResolver.xml | Removes .NET Framework-only note text and inheritance-demand block. |
| xml/System.Xml/XmlTextReader.xml | Removes partial-trust guidance and cleans up markdown formatting. |
| xml/System.Xml/XmlSecureResolver.xml | Removes partial-trust/CAS-era remarks and simplifies exception docs. |
| xml/System.Xml/XmlReaderSettings.xml | Updates resolver-related docs (currently contains unresolved merge markers and contradictory default text). |
| xml/System.Xml/XmlReader.xml | Updates resolver guidance and “.NET Framework” wording (introduced a contradiction now addressed in comments). |
| xml/System.Xml/XmlNodeReader.xml | Removes .NET Framework version phrasing and fixes a previously broken sentence. |
| xml/System.Xml/XmlDocument.xml | Removes full-trust inheritance-demand blocks and updates resolver wording. |
| xml/System.Xml/XmlConvert.xml | Removes .NET Framework-versioned obsolete notes and replaces with placeholders. |
| xml/System.Xml/ValidationType.xml | Removes .NET Framework 2.0-specific wording from enum member docs. |
| xml/System.Xml/IApplicationResourceStreamResolver.xml | Updates Obsolete attribute message to “.NET infrastructure”. |
| xml/System.Xml.Xsl/XslCompiledTransform.xml | Rewords “Microsoft .NET Framework” references to “.NET” and trims formatting. |
| xml/System.Xml.Serialization/XmlSerializerVersionAttribute.xml | Rewords remarks from “.NET Framework” to “.NET” and normalizes markdown whitespace. |
| xml/System.Xml.Serialization/XmlSerializerAssemblyAttribute.xml | Removes machine.config-based instructions and replaces with placeholder remarks. |
| xml/System.Xml.Serialization/XmlSerializationWriter.xml | Rewords multiple remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSerializationWriteCallback.xml | Rewords serialization infrastructure remarks for modern .NET. |
| xml/System.Xml.Serialization/XmlSerializationReader+Fixup.xml | Rewords deserialization remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSerializationReader+CollectionFixup.xml | Rewords collection fixup remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSerializationReader.xml | Rewords many remarks/params/returns from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSerializationReadCallback.xml | Rewords callback remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSerializationFixupCallback.xml | Rewords fixup callback remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSerializationCollectionFixupCallback.xml | Rewords collection fixup callback remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSchemas.xml | Rewords remark about infrastructure caller from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlSchemaImporter.xml | Rewords “.NET Framework” Web service behavior reference to “.NET”. |
| xml/System.Xml.Serialization/XmlReflectionMember.xml | Rewords initialization/interop remarks from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlReflectionImporter.xml | Rewords parameter descriptions from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlMembersMapping.xml | Rewords initialization and mapping descriptions from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/XmlMemberMapping.xml | Rewords Xsd.exe mapping remarks and WSDL binding note from “.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/IXmlSerializable.xml | Rewords framework responsibilities from “the framework”/“.NET Framework” to “.NET”. |
| xml/System.Xml.Serialization/CodeIdentifier.xml | Rewords tooling guidance to remove “.NET Framework” phrasing. |
| xml/System.Xml.Schema/XmlTypeCode.xml | Rewords enum member summaries to “.NET infrastructure”. |
| xml/System.Xml.Schema/XmlSchemaElement.xml | Removes .NET Framework 2.0-era obsoletion note and replaces with placeholder remarks. |
| xml/System.Xml.Schema/XmlSchemaCollection.xml | Removes extensive legacy remarks and replaces with placeholder remarks. |
| xml/System.Xml.Schema/XmlSchemaAttribute.xml | Removes .NET Framework 2.0-era obsoletion note and replaces with placeholder remarks. |
| xml/System.Xml.Schema/XmlSchema.xml | Removes .NET Framework 2.0-era Compile obsoletion note and replaces with placeholder remarks. |
| xml/System.Xml.Resolvers/XmlPreloadedResolver.xml | Removes Silverlight/.NET Framework-specific parameter explanation. |
| xml/System.Xaml/XamlSchemaContext.xml | Removes AppDomain/partial-trust block text. |
| xml/System.Xaml/XamlObjectWriterSettings.xml | Replaces partial-trust remarks with placeholder text. |
| xml/System.Xaml/XamlObjectWriter.xml | Rewords remarks to remove framework wording (contains a typo noted in comments). |
| xml/System.Xaml.Permissions/XamlLoadPermission.xml | Removes partial-trust relevance line and replaces several remarks with placeholders. |
Comment on lines
+2430
to
+2431
| <<<<<<< HEAD | ||
| <Member MemberName="Settings"> |
Comment on lines
2491
to
2493
| ======= | ||
| >>>>>>> a616b87eb03a89aa522fa6635e20af8ab7093d32 | ||
| <Member MemberName="System.Xml.IXmlNamespaceResolver.GetNamespacesInScope"> |
Comment on lines
+157
to
+158
| <<<<<<< HEAD | ||
| <Member MemberName=".ctor"> |
Comment on lines
197
to
199
| ======= | ||
| >>>>>>> a616b87eb03a89aa522fa6635e20af8ab7093d32 | ||
| <Member MemberName="Async"> |
|
|
||
| ## Remarks | ||
| XAML schema context is a necessary information source for most practical object-writing scenarios. The XAML schema context influences the type lookup for backing types and holds information about the assemblies where backing types exist. The default XAML schema context is based on CLR type-mapping rules. Frameworks typically provide their own XAML schema context in order to assure that the assembly-loading mechanisms match the framework's programming amd application models. | ||
| XAML schema context is a necessary information source for most practical object-writing scenarios. The XAML schema context influences the type lookup for backing types and holds information about the assemblies where backing types exist. The default XAML schema context is based on CLR type-mapping rules. Frameworks typically provide their own XAML schema context in order to assure that the assembly-loading mechanisms match .NET's programming amd application models. |
| <Docs> | ||
| <summary>Sets the <see cref="T:System.Xml.XmlResolver" /> used to access external documents.</summary> | ||
| <value>An <see cref="T:System.Xml.XmlResolver" /> used to access external documents. If set to <see langword="null" />, an <see cref="T:System.Xml.XmlException" /> is thrown when the <see cref="T:System.Xml.XmlReader" /> tries to access an external resource. The default is a new <see cref="T:System.Xml.XmlUrlResolver" /> with no credentials. Starting with the .NET Framework 4.5.2, this setting has a default value of <see langword="null" />.</value> | ||
| <value>An <see cref="T:System.Xml.XmlResolver" /> used to access external documents. If set to <see langword="null" />, an <see cref="T:System.Xml.XmlException" /> is thrown when the <see cref="T:System.Xml.XmlReader" /> tries to access an external resource. The default is a new <see cref="T:System.Xml.XmlUrlResolver" /> with no credentials. This setting has a default value of <see langword="null" />.</value> |
| <param name="value">The object value to write. | ||
|
|
||
| **Note** With the release of the .NET Framework 3.5, this method accepts <see cref="T:System.DateTimeOffset" /> as a parameter.</param> | ||
| <param name="value">The object value to write.</param> |
| <para>This class has an inheritance demand. Full trust is required to inherit from <see langword="XmlValidatingReader" />.</para> | ||
| </block> | ||
| <summary>Represents a reader that provides document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) validation.</summary> | ||
| <remarks>To be added.</remarks> |
Comment on lines
513
to
+516
| A default <xref:System.Xml.XmlUrlResolver> with no credentials is used to access any external resources such as a document type definition (DTD), entities, schemas, and so on. | ||
|
|
||
| > [!IMPORTANT] | ||
| > Starting with the .NET Framework 4.5.2, no default <xref:System.Xml.XmlUrlResolver> is provided. If your solution targets the .NET Framework 4.5.2 or later versions, specify an <xref:System.Xml.XmlResolver> using the <xref:System.Xml.XmlReaderSettings.XmlResolver?displayProperty=nameWithType> property. | ||
| > No default <xref:System.Xml.XmlUrlResolver> is provided. Specify an <xref:System.Xml.XmlResolver> using the <xref:System.Xml.XmlReaderSettings.XmlResolver?displayProperty=nameWithType> property. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
.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 and examples related to:
Also remarks all remarks from obsolete APIs.
Hide whitespace changes