Skip to content

Commit

Permalink
Add deprecation notice and links (#9221)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
ghogen authored Oct 26, 2023
1 parent ed404c0 commit 9a26a2f
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions src/Framework/CustomBuildEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ namespace Microsoft.Build.Framework
/// <summary>
/// Arguments for custom build events.
/// </summary>
// WARNING: marking a type [Serializable] without implementing
// ISerializable imposes a serialization contract -- it is a
// promise to never change the type's fields i.e. the type is
// immutable; adding new fields in the next version of the type
// without following certain special FX guidelines, can break both
// forward and backward compatibility
/// <remarks>
/// In MSBuild 17.8 and later, this type is deprecated; instead use <see cref="ExtendedCustomBuildEventArgs"/>.
/// For more information, see <see href="https://learn.microsoft.com/dotnet/core/compatibility/sdk/8.0/custombuildeventargs"/>
/// </remarks>
[Serializable]
public abstract class CustomBuildEventArgs : LazyFormattedBuildEventArgs
{
Expand Down

0 comments on commit 9a26a2f

Please sign in to comment.