Skip to content

Commit 9a26a2f

Browse files
authored
Add deprecation notice and links (#9221)
Fixes #9220 CustomBuildEventArgs is deprecated. Users are advised to use ExtendedCustomBuildEventArgs instead. See #8917 The comment change results in a public-facing doc change at https://learn.microsoft.com/en-us/dotnet/api/microsoft.build.framework.custombuildeventargs?view=msbuild-17-netcore The new Remarks section includes a link to a public-facing doc that explains the change: https://learn.microsoft.com/en-us/dotnet/core/compatibility/sdk/8.0/custombuildeventargs
1 parent ed404c0 commit 9a26a2f

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

src/Framework/CustomBuildEventArgs.cs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ namespace Microsoft.Build.Framework
1010
/// <summary>
1111
/// Arguments for custom build events.
1212
/// </summary>
13-
// WARNING: marking a type [Serializable] without implementing
14-
// ISerializable imposes a serialization contract -- it is a
15-
// promise to never change the type's fields i.e. the type is
16-
// immutable; adding new fields in the next version of the type
17-
// without following certain special FX guidelines, can break both
18-
// forward and backward compatibility
13+
/// <remarks>
14+
/// In MSBuild 17.8 and later, this type is deprecated; instead use <see cref="ExtendedCustomBuildEventArgs"/>.
15+
/// For more information, see <see href="https://learn.microsoft.com/dotnet/core/compatibility/sdk/8.0/custombuildeventargs"/>
16+
/// </remarks>
1917
[Serializable]
2018
public abstract class CustomBuildEventArgs : LazyFormattedBuildEventArgs
2119
{

0 commit comments

Comments
 (0)