Remove remarks from obsolete APIs

[gewarren]

Contributes to #12513.

[Copilot]

Pull request overview

This PR updates the .NET API reference ECMA XML by removing existing <remarks> content (often markdown blocks with usage notes/examples) from a broad set of APIs—primarily obsolete/deprecated members such as formatter-based serialization constructors and legacy APIs—aligning with the cleanup work tracked in #12513.

Changes:

• Removed many existing <remarks> markdown blocks (including some examples and guidance) across numerous XML type/member docs.
• Replaced removed remark blocks with placeholder <remarks>To be added.</remarks> in many locations.
• Removed/trimmed some related guidance content that was embedded in remarks (for example, security notes and usage guidance).

Reviewed changes

Copilot reviewed 229 out of 229 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
xml/System/WeakReference.xml	Removes remarks from obsolete serialization-related members.
xml/System/UriFormatException.xml	Removes remarks from obsolete serialization constructor.
xml/System/TypeUnloadedException.xml	Removes remarks from obsolete serialization constructor.
xml/System/TypeLoadException.xml	Removes remarks/examples from obsolete serialization members.
xml/System/TypeAccessException.xml	Removes remarks from obsolete serialization constructor.
xml/System/Type.xml	Removes remarks/examples from IsSerializable docs.
xml/System/TimeZoneNotFoundException.xml	Removes remarks from obsolete serialization constructor.
xml/System/TimeZone.xml	Removes type-level remarks for obsolete TimeZone.
xml/System/TimeoutException.xml	Removes remarks from obsolete serialization constructor.
xml/System/SystemException.xml	Removes remarks from obsolete serialization constructor.
xml/System/String.xml	Removes remarks/examples from obsolete String.Copy.
xml/System/Span`1.xml	Removes remarks from obsolete Span<T>.Equals(object).
xml/System/RuntimeTypeHandle.xml	Removes remarks from obsolete serialization-related member.
xml/System/RuntimeMethodHandle.xml	Removes remarks from obsolete serialization-related member.
xml/System/RuntimeFieldHandle.xml	Removes remarks from obsolete serialization-related member.
xml/System/RankException.xml	Removes remarks from obsolete serialization constructor.
xml/System/OverflowException.xml	Removes remarks from obsolete serialization constructor.
xml/System/OutOfMemoryException.xml	Removes remarks from obsolete serialization constructor.
xml/System/OperationCanceledException.xml	Removes remarks from obsolete serialization constructor.
xml/System/OperatingSystem.xml	Removes remarks from obsolete serialization-related member.
xml/System/NullReferenceException.xml	Removes remarks from obsolete serialization constructor.
xml/System/NotSupportedException.xml	Removes remarks from obsolete serialization constructor.
xml/System/NotFiniteNumberException.xml	Removes remarks from obsolete serialization members.
xml/System/MulticastDelegate.xml	Removes remarks from obsolete serialization-related member.
xml/System/MissingMethodException.xml	Removes remarks from obsolete serialization constructor.
xml/System/MissingMemberException.xml	Removes remarks from obsolete serialization members.
xml/System/MissingFieldException.xml	Removes remarks from obsolete serialization constructor.
xml/System/MethodAccessException.xml	Removes remarks from obsolete serialization constructor.
xml/System/MemberAccessException.xml	Removes remarks from obsolete serialization constructor.
xml/System/InvalidTimeZoneException.xml	Removes remarks from obsolete serialization constructor.
xml/System/InvalidOperationException.xml	Removes remarks from obsolete serialization constructor.
xml/System/InvalidCastException.xml	Removes remarks from obsolete serialization constructor.
xml/System/FormatException.xml	Removes remarks from obsolete serialization constructor.
xml/System/FieldAccessException.xml	Removes remarks from obsolete serialization constructor.
xml/System/Enum.xml	Removes remarks from obsolete overload docs.
xml/System/EntryPointNotFoundException.xml	Removes remarks from obsolete serialization constructor.
xml/System/DuplicateWaitObjectException.xml	Removes remarks from obsolete serialization constructor.
xml/System/DivideByZeroException.xml	Removes remarks from obsolete serialization constructor.
xml/System/CannotUnloadAppDomainException.xml	Removes remarks from obsolete serialization constructor.
xml/System/BadImageFormatException.xml	Removes remarks from obsolete serialization constructor.
xml/System/ArrayTypeMismatchException.xml	Removes remarks from obsolete serialization constructor.
xml/System/ArithmeticException.xml	Removes remarks from obsolete serialization constructor.
xml/System/ArgumentOutOfRangeException.xml	Removes remarks from obsolete serialization members.
xml/System/ArgumentNullException.xml	Removes remarks from obsolete serialization constructor.
xml/System/ArgumentException.xml	Removes remarks from obsolete serialization members.
xml/System/ApplicationException.xml	Removes remarks from obsolete serialization constructor.
xml/System/AppDomainUnloadedException.xml	Removes remarks from obsolete serialization constructor.
xml/System/AggregateException.xml	Removes remarks from obsolete serialization constructors.
xml/System/AccessViolationException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Xml/XmlTextReader.xml	Removes remarks (including security guidance) from obsolete DTD property.
xml/System.Xml/XmlReaderSettings.xml	Removes remarks (including security guidance) from obsolete DTD property.
xml/System.Xml/XmlDataDocument.xml	Removes type-level remarks for XmlDataDocument.
xml/System.Xml.Schema/XmlSchemaValidationException.xml	Removes remarks from serialization constructor.
xml/System.Xml.Schema/XmlSchemaType.xml	Removes remarks from obsolete property docs.
xml/System.Xml.Schema/XmlSchemaInferenceException.xml	Removes remarks from serialization constructor.
xml/System.Windows/UIElement.xml	Removes remarks from several dependency-property docs.
xml/System.Windows.Media/DrawingContext.xml	Removes remarks from PushEffect.
xml/System.Windows.Media.Media3D/Viewport3DVisual.xml	Removes remarks from bitmap effect properties.
xml/System.Windows.Media.Effects/BitmapEffect.xml	Removes remarks from multiple members.
xml/System.Windows.Markup/IReceiveMarkupExtension.xml	Removes remarks describing obsolete interface behavior.
xml/System.Windows.Data/ListCollectionView.xml	Removes remarks from obsolete override member.
xml/System.Web/HttpUtility.xml	Removes remarks from URL/unicode conversion helpers.
xml/System.Threading/WaitHandleCannotBeOpenedException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/WaitHandle.xml	Removes remarks about handle-leak risk on obsolete Handle.
xml/System.Threading/ThreadStateException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/ThreadInterruptedException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/Thread.xml	Removes remarks from obsolete ApartmentState property.
xml/System.Threading/SynchronizationLockException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/SemaphoreFullException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/Overlapped.xml	Removes remarks from multiple members.
xml/System.Threading/LockRecursionException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/BarrierPostPhaseException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading/AbandonedMutexException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading.Tasks/TaskSchedulerException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Threading.Tasks/TaskCanceledException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Text/UTF7Encoding.xml	Removes remarks/examples from constructors.
xml/System.Text/Encoding.xml	Removes remarks/examples for UTF7 encoding.
xml/System.Text.Json/JsonSerializerOptions.xml	Removes remarks from multiple members.
xml/System.Security/VerificationException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Security/SecurityException.xml	Removes remarks/examples from obsolete serialization members.
xml/System.Security/SecurityCriticalScope.xml	Removes type-level remarks.
xml/System.Security.Principal/WindowsIdentity.xml	Removes remarks containing include-based security note.
xml/System.Security.Policy/Evidence.xml	Removes remarks from evidence-add methods.
xml/System.Security.Cryptography/SHA512Managed.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/SHA512.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/SHA384Managed.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/SHA256Managed.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/SHA1Managed.xml	Removes type-level remarks.
xml/System.Security.Cryptography/SHA1CryptoServiceProvider.xml	Removes type-level remarks.
xml/System.Security.Cryptography/SHA1.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/RNGCryptoServiceProvider.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/RijndaelManaged.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/Rijndael.xml	Removes type-level remarks and factory-method remarks.
xml/System.Security.Cryptography/RC2CryptoServiceProvider.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/PasswordDeriveBytes.xml	Removes remarks from CryptDeriveKey.
xml/System.Security.Cryptography/MD5CryptoServiceProvider.xml	Removes type-level remarks.
xml/System.Security.Cryptography/MD5.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/KeyedHashAlgorithm.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/HMACSHA1.xml	Removes remarks from constructor.
xml/System.Security.Cryptography/HMAC.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/ECDsa.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/ECDiffieHellmanPublicKey.xml	Removes remarks from constructor.
xml/System.Security.Cryptography/ECDiffieHellman.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/DSA.xml	Removes remarks from factory method.
xml/System.Security.Cryptography/DESCryptoServiceProvider.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/CryptographicUnexpectedOperationException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Security.Cryptography/CryptographicException.xml	Removes remarks from obsolete serialization constructor.
xml/System.Security.Cryptography/CryptoConfig.xml	Removes remarks/examples from EncodeOID.
xml/System.Security.Cryptography/AsymmetricAlgorithm.xml	Removes remarks/examples from factory method.
xml/System.Security.Cryptography/AesManaged.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/AesCryptoServiceProvider.xml	Removes type-level remarks/examples.
xml/System.Security.Cryptography/Aes.xml	Removes remarks from factory method.
xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml	Removes remarks from constructor.
xml/System.Security.Cryptography.X509Certificates/PublicKey.xml	Removes remarks/examples from Key property.
xml/System.Security.Authentication.ExtendedProtection/ExtendedProtectionPolicy.xml	Removes remarks from serialization constructor.
xml/System.Runtime/ControlledExecution.xml	Removes remarks describing behavior and risks of abortable execution.
xml/System.Runtime.Serialization/SurrogateSelector.xml	Removes type-level remarks.
xml/System.Runtime.Serialization/StreamingContext.xml	Removes remarks from State property.
xml/System.Runtime.Serialization/SerializationObjectManager.xml	Removes type-level remarks.
xml/System.Runtime.Serialization/SerializationInfo.xml	Removes remarks from constructor.
xml/System.Runtime.Serialization/SerializationException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.Serialization/SafeSerializationEventArgs.xml	Removes type-level remarks.
xml/System.Runtime.Serialization/ObjectManager.xml	Removes type-level remarks/examples.
xml/System.Runtime.Serialization/ObjectIDGenerator.xml	Removes type-level remarks.
xml/System.Runtime.Serialization/ISurrogateSelector.xml	Removes type-level remarks.
xml/System.Runtime.Serialization/ISerializable.xml	Removes remarks from GetObjectData.
xml/System.Runtime.Serialization/InvalidDataContractException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.Serialization/IFormatter.xml	Removes type-level remarks.
xml/System.Runtime.Serialization/Formatter.xml	Removes type-level remarks.
xml/System.Runtime.Serialization.Formatters/TypeFilterLevel.xml	Removes remarks containing include content.
xml/System.Runtime.Serialization.Formatters/FormatterTypeStyle.xml	Removes type-level remarks.
xml/System.Runtime.Serialization.Formatters.Binary/BinaryFormatter.xml	Removes type-level security warning remarks.
xml/System.Runtime.InteropServices/SEHException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/SafeArrayTypeMismatchException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/SafeArrayRankMismatchException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/MarshalDirectiveException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/InvalidOleVariantTypeException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/InvalidComObjectException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/ExternalException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.InteropServices/CurrencyWrapper.xml	Removes type-level remarks.
xml/System.Runtime.InteropServices/COMException.xml	Removes remarks from serialization constructor.
xml/System.Runtime.CompilerServices/SuppressIldasmAttribute.xml	Removes remarks/examples from type docs.
xml/System.Runtime.CompilerServices/RuntimeWrappedException.xml	Removes remarks from GetObjectData.
xml/System.Runtime.CompilerServices/RuntimeHelpers.xml	Removes remarks from OffsetToStringData.
xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml	Removes type-level remarks.
xml/System.Resources/MissingSatelliteAssemblyException.xml	Removes remarks from serialization constructor.
xml/System.Resources/MissingManifestResourceException.xml	Removes remarks from serialization constructor.
xml/System.Reflection/StrongNameKeyPair.xml	Removes type-level remarks/examples.
xml/System.Reflection/ParameterInfo.xml	Removes remarks from GetRealObject.
xml/System.Reflection/FieldInfo.xml	Removes remarks/examples from IsNotSerialized.
xml/System.Reflection/AssemblyName.xml	Removes remarks/examples from multiple members.
xml/System.Reflection/AssemblyFlagsAttribute.xml	Removes remarks from AssemblyFlags.
xml/System.Reflection/Assembly.xml	Removes remarks/examples from CodeBase.
xml/System.Reflection.Emit/AssemblyBuilder.xml	Removes remarks from CodeBase.
xml/System.Net/WriteStreamClosedEventArgs.xml	Removes remarks from Error property.
xml/System.Net/WebResponse.xml	Removes remarks from serialization members.
xml/System.Net/WebHeaderCollection.xml	Removes remarks from serialization members.
xml/System.Net/WebException.xml	Removes remarks from serialization constructor.
xml/System.Net/WebClient.xml	Removes remarks/examples from ctor and buffering property.
xml/System.Net/ServicePointManager.xml	Removes remarks/examples from FindServicePoint overloads.
xml/System.Net/ProtocolViolationException.xml	Removes remarks from serialization members.
xml/System.Net/HttpWebResponse.xml	Removes remarks from serialization members.
xml/System.Net/HttpWebRequest.xml	Removes remarks from serialization members.
xml/System.Net/GlobalProxySelection.xml	Removes type-level remarks.
xml/System.Net/FileWebResponse.xml	Removes remarks from serialization members.
xml/System.Net/FileWebRequest.xml	Removes remarks from serialization members.
xml/System.Net/CookieException.xml	Removes remarks from serialization members.
xml/System.Net.Sockets/TcpListener.xml	Removes remarks from obsolete ctor.
xml/System.Net.Sockets/SocketException.xml	Removes remarks from serialization constructor.
xml/System.Net.Sockets/Socket.xml	Removes remarks from obsolete networking properties.
xml/System.Net.NetworkInformation/PingException.xml	Removes remarks from serialization constructor.
xml/System.Net.NetworkInformation/NetworkInformationException.xml	Removes remarks from serialization constructor.
xml/System.Net.Mail/SmtpFailedRecipientsException.xml	Removes remarks from serialization constructor.
xml/System.Net.Mail/SmtpFailedRecipientException.xml	Removes remarks from serialization members.
xml/System.Net.Mail/SmtpException.xml	Removes remarks from serialization members.
xml/System.Net.Mail/MailMessage.xml	Removes remarks from ReplyTo property.
xml/System.Net.Http/HttpRequestMessage.xml	Removes remarks from obsolete Properties docs.
xml/System.Linq.Expressions/Expression.xml	Removes remarks from protected constructor.
xml/System.IO/Stream.xml	Removes remarks from CreateWaitHandle.
xml/System.IO/Path.xml	Removes remarks containing caution from obsolete field.
xml/System.IO/FileSystemInfo.xml	Removes remarks from serialization members.
xml/System.IO.Pipelines/PipeWriter.xml	Removes remarks (including deprecation warning) from callback member.
xml/System.IO.Pipelines/PipeReader.xml	Removes remarks (including deprecation warning) from callback member.
xml/System.IO.IsolatedStorage/IsolatedStorageFileStream.xml	Removes remarks from Handle property docs.
xml/System.IO.IsolatedStorage/IsolatedStorageFile.xml	Removes remarks from size/quota property docs.
xml/System.IO.IsolatedStorage/IsolatedStorageException.xml	Removes remarks from serialization constructor.
xml/System.IO.IsolatedStorage/IsolatedStorage.xml	Removes remarks from size/quota property docs.
xml/System.Globalization/CultureNotFoundException.xml	Removes remarks from serialization members.
xml/System.Diagnostics/Process.xml	Removes remarks from obsolete working-set members.
xml/System.Diagnostics.SymbolStore/ISymbolBinder.xml	Removes remarks from GetReader.
xml/System.Data/StrongTypingException.xml	Removes remarks from serialization constructor.
xml/System.Data/DataTable.xml	Removes remarks from serialization constructor.
xml/System.Data/DataSet.xml	Removes remarks (including untrusted-data include) from serialization constructors.
xml/System.Data.SqlTypes/SqlTypeException.xml	Removes remarks from serialization constructor.
xml/System.Data.OleDb/OleDbParameterCollection.xml	Removes remarks from Add overload docs.
xml/System.Data.Odbc/OdbcParameterCollection.xml	Removes remarks from Add overload docs.
xml/System.Data.Common/DbException.xml	Removes remarks from serialization constructor.
xml/System.Data.Common/DataAdapter.xml	Removes remarks from deprecated cloning method docs.
xml/System.ComponentModel/RecommendedAsConfigurableAttribute.xml	Removes type-level remarks.
xml/System.ComponentModel.Design/DesignSurface.xml	Removes remarks from CreateComponent.
xml/System.ComponentModel.Design.Serialization/RootDesignerSerializerAttribute.xml	Removes type-level remarks/examples.
xml/System.ComponentModel.DataAnnotations/ValidationException.xml	Removes remarks from serialization constructor.
xml/System.ComponentModel.DataAnnotations/FilterUIHintAttribute.xml	Removes type-level examples/remarks.
xml/System.Collections/IHashCodeProvider.xml	Removes type-level remarks.
xml/System.Collections/Comparer.xml	Removes remarks from GetObjectData.
xml/System.Collections/CaseInsensitiveHashCodeProvider.xml	Removes type-level remarks.
xml/System.Collections.Specialized/OrderedDictionary.xml	Removes remarks from serialization constructor.
xml/System.Collections.Specialized/NameValueCollection.xml	Removes remarks from constructors/serialization ctor.
xml/System.Collections.Generic/SortedSet`1.xml	Removes remarks from serialization constructor.
xml/System.Collections.Generic/LinkedList`1.xml	Removes remarks from serialization members.
xml/System.Collections.Generic/KeyNotFoundException.xml	Removes remarks from serialization constructor.
xml/System.Collections.Generic/HashSet`1.xml	Removes remarks from serialization members.
xml/System.Collections.Generic/Dictionary`2.xml	Removes remarks from serialization members.
xml/Microsoft.VisualBasic.FileIO/MalformedLineException.xml	Removes remarks from serialization members.
xml/Microsoft.VisualBasic.CompilerServices/NewLateBinding.xml	Removes remarks from helper method docs.
xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderInternalCompilerException.xml	Removes remarks from serialization constructor.
xml/Microsoft.CSharp.RuntimeBinder/RuntimeBinderException.xml	Removes remarks from serialization constructor.

[BillWagner]

This LGTM, pending the resolution of the warnings.

[gewarren]

@BillWagner Can you reapprove? I had to resolve a merge conflict.

The warnings are coming from these lines, where presumably the interfaces only exist in certain versions (.NET 10/11): https://github.com/gewarren/dotnet-api-docs/blob/031a8a0a708149863ad1baf906333201d18b40e2/xml/System.Runtime.Serialization/Formatter.xml#L403-L406

[BillWagner]

This LGTM