Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added missing deprecation notices to Lua docs #21110

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Added missing deprecation notices to Lua docs #21110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 27 additions & 3 deletions OpenRA.Mods.Common/UtilityCommands/ExtractLuaDocsCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,18 @@ void IUtilityCommand.Run(Utility utility, string[] args)
Console.WriteLine();
Console.WriteLine("| Function | Description |");
Console.WriteLine("|---------:|-------------|");

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 />") : "";
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} |");
}
}

Expand Down Expand Up @@ -105,12 +113,17 @@ void IUtilityCommand.Run(Utility utility, string[] args)
foreach (var property in kv.OrderBy(p => p.mi.Name))
{
var mi = property.mi;
var memberString = mi.LuaDocString();
var required = property.required;
var hasDesc = Utility.HasAttribute<DescAttribute>(mi);
var hasRequires = required.Length > 0;
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)
Console.Write("<br />*Queued Activity*");
Expand All @@ -126,6 +139,9 @@ void IUtilityCommand.Run(Utility utility, string[] args)
if (hasRequires)
Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}");

if (isDeprecated)
Console.Write($"**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(mi, true).First().Message}**");

Console.WriteLine(" |");
}
}
Expand Down Expand Up @@ -154,12 +170,17 @@ void IUtilityCommand.Run(Utility utility, string[] args)
foreach (var property in kv.OrderBy(p => p.mi.Name))
{
var mi = property.mi;
var memberString = mi.LuaDocString();
var required = property.required;
var hasDesc = Utility.HasAttribute<DescAttribute>(mi);
var hasRequires = required.Length > 0;
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)
Console.Write("<br />*Queued Activity*");
Expand All @@ -175,6 +196,9 @@ void IUtilityCommand.Run(Utility utility, string[] args)
if (hasRequires)
Console.Write($"**Requires {(required.Length == 1 ? "Trait" : "Traits")}:** {required.JoinWith(", ")}");

if (isDeprecated)
Console.Write($"**Deprecated: {Utility.GetCustomAttributes<ObsoleteAttribute>(mi, true).First().Message}**");

Console.WriteLine(" |");
}

Expand Down