epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added missing deprecation notices to Lua docs

Browse Source
This commit is contained in:
Pavel Penev
2023-10-10 16:05:59 +03:00
committed by Matthias Mailänder
parent 36d44925cb
commit 7515c180b9
1 changed files with 27 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
OpenRA.Mods.Common/UtilityCommands/ExtractLuaDocsCommand.cs
View File

@@ -74,10 +74,18 @@ namespace OpenRA.Mods.Common.UtilityCommands
Console.WriteLine(); Console.WriteLine();
Console.WriteLine("| Function | Description |"); Console.WriteLine("| Function | Description |");
Console.WriteLine("|---------:|-------------|"); Console.WriteLine("|---------:|-------------|");
foreach (var m in members.OrderBy(m => m.Name)) foreach (var m in members.OrderBy(m => m.Name))
{ {
var memberString = m.LuaDocString();
var desc = Utility.HasAttribute<DescAttribute>(m) ? Utility.GetCustomAttributes<DescAttribute>(m, true).First().Lines.JoinWith("<br />") : ""; var desc = Utility.HasAttribute<DescAttribute>(m) ? Utility.GetCustomAttributes<DescAttribute>(m, true).First().Lines.JoinWith("<br />") : "";
Console.WriteLine($"| **{m.LuaDocString()}** | {desc} |"); if (Utility.HasAttribute<ObsoleteAttribute>(m))
{
memberString = $"<s>{memberString}</s>";
desc += $"<br />**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(m, true).First().Message}**";
}
Console.WriteLine($"| **{memberString}** | {desc} |");
} }
} }
@@ -105,12 +113,17 @@ namespace OpenRA.Mods.Common.UtilityCommands
foreach (var property in kv.OrderBy(p => p.mi.Name)) foreach (var property in kv.OrderBy(p => p.mi.Name))
{ {
var mi = property.mi; var mi = property.mi;
var memberString = mi.LuaDocString();
var required = property.required; var required = property.required;
var hasDesc = Utility.HasAttribute<DescAttribute>(mi); var hasDesc = Utility.HasAttribute<DescAttribute>(mi);
var hasRequires = required.Length > 0; var hasRequires = required.Length > 0;
var isActivity = Utility.HasAttribute<ScriptActorPropertyActivityAttribute>(mi); var isActivity = Utility.HasAttribute<ScriptActorPropertyActivityAttribute>(mi);
var isDeprecated = Utility.HasAttribute<ObsoleteAttribute>(mi);
Console.Write($"| **{mi.LuaDocString()}**"); if (isDeprecated)
Console.Write($"| **<s>{memberString}</s>**");
else
Console.Write($"| **{memberString}**");
if (isActivity) if (isActivity)
Console.Write("<br />*Queued Activity*"); Console.Write("<br />*Queued Activity*");
@@ -126,6 +139,9 @@ namespace OpenRA.Mods.Common.UtilityCommands
if (hasRequires) if (hasRequires)
Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}"); Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}");
if (isDeprecated)
Console.Write($"**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(mi, true).First().Message}**");
Console.WriteLine(" |"); Console.WriteLine(" |");
} }
} }
@@ -154,12 +170,17 @@ namespace OpenRA.Mods.Common.UtilityCommands
foreach (var property in kv.OrderBy(p => p.mi.Name)) foreach (var property in kv.OrderBy(p => p.mi.Name))
{ {
var mi = property.mi; var mi = property.mi;
var memberString = mi.LuaDocString();
var required = property.required; var required = property.required;
var hasDesc = Utility.HasAttribute<DescAttribute>(mi); var hasDesc = Utility.HasAttribute<DescAttribute>(mi);
var hasRequires = required.Length > 0; var hasRequires = required.Length > 0;
var isActivity = Utility.HasAttribute<ScriptActorPropertyActivityAttribute>(mi); var isActivity = Utility.HasAttribute<ScriptActorPropertyActivityAttribute>(mi);
var isDeprecated = Utility.HasAttribute<ObsoleteAttribute>(mi);
Console.Write($"| **{mi.LuaDocString()}**"); if (isDeprecated)
Console.Write($"| **<s>{memberString}</s>**");
else
Console.Write($"| **{memberString}**");
if (isActivity) if (isActivity)
Console.Write("<br />*Queued Activity*"); Console.Write("<br />*Queued Activity*");
@@ -175,6 +196,9 @@ namespace OpenRA.Mods.Common.UtilityCommands
if (hasRequires) if (hasRequires)
Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}"); Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}");
if (isDeprecated)
Console.Write($"**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(mi, true).First().Message}**");
Console.WriteLine(" |"); Console.WriteLine(" |");
} }