Add obsoletion warnings to serialization source generated methods, xmldocs (#4364)

This commit is contained in:
DrSmugleaf
2023-09-11 03:15:07 -07:00
committed by GitHub
parent 25007a743f
commit 4666a87aa5
2 changed files with 22 additions and 0 deletions

View File

@@ -209,6 +209,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
""";
baseCopy = $$"""
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public override void Copy(ref {{baseName}} target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
var cast = ({{definition.GenericTypeName}}) target;
@@ -216,6 +218,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
target = cast!;
}
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public override void Copy(ref object target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
var cast = ({{definition.GenericTypeName}}) target;
@@ -227,6 +231,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
else
{
baseCopy = $$"""
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public {{modifiers}} void Copy(ref object target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
var cast = ({{definition.GenericTypeName}}) target;
@@ -237,12 +243,16 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
}
builder.AppendLine($$"""
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public {{modifiers}} void InternalCopy(ref {{definition.GenericTypeName}} target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
{{baseCall}}
{{CopyDataFields(definition)}}
}
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public {{modifiers}} void Copy(ref {{definition.GenericTypeName}} target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
InternalCopy(ref target, serialization, hookCtx, context);
@@ -259,6 +269,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
var interfaceName = @interface.ToDisplayString();
builder.AppendLine($$"""
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public {{interfaceModifiers}} void InternalCopy(ref {{interfaceName}} target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
var def = ({{definition.GenericTypeName}}) target;
@@ -266,6 +278,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
target = def;
}
/// <seealso cref="ISerializationManager.CopyTo"/>
[Obsolete("Use ISerializationManager.CopyTo instead")]
public {{interfaceModifiers}} void Copy(ref {{interfaceName}} target, ISerializationManager serialization, SerializationHookContext hookCtx, ISerializationContext? context = null)
{
InternalCopy(ref target, serialization, hookCtx, context);
@@ -290,6 +304,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
{
// TODO make abstract once data definitions are forced to be partial
builder.AppendLine($$"""
/// <seealso cref="ISerializationManager.CreateCopy"/>
[Obsolete("Use ISerializationManager.CreateCopy instead")]
public {{modifiers}} {{definition.GenericTypeName}} Instantiate()
{
throw new NotImplementedException();
@@ -299,6 +315,8 @@ using Robust.Shared.Serialization.TypeSerializers.Interfaces;
else
{
builder.AppendLine($$"""
/// <seealso cref="ISerializationManager.CreateCopy"/>
[Obsolete("Use ISerializationManager.CreateCopy instead")]
public {{modifiers}} {{definition.GenericTypeName}} Instantiate()
{
return new {{definition.GenericTypeName}}();