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

Added some sorting to documentation output

Browse Source
This commit is contained in:
penev92
2022-09-13 22:20:15 +03:00
committed by Matthias Mailänder
parent 6b98a75658
commit 04afa4a72c
4 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
OpenRA.Mods.Common/UtilityCommands/ExtractSequenceDocsCommand.cs
View File

@@ -40,7 +40,7 @@ namespace OpenRA.Mods.Common.UtilityCommands
version = args[1];
var objectCreator = utility.ModData.ObjectCreator;
var spriteSequenceTypes = objectCreator.GetTypesImplementing<ISpriteSequence>().OrderBy(t => t.Namespace);
var spriteSequenceTypes = objectCreator.GetTypesImplementing<ISpriteSequence>().OrderBy(t => t.Namespace).ThenBy(t => t.Name);
var json = GenerateJson(version, spriteSequenceTypes);
Console.WriteLine(json);
@@ -91,7 +91,7 @@ namespace OpenRA.Mods.Common.UtilityCommands
})
});
var relatedEnums = relatedEnumTypes.Select(type => new
var relatedEnums = relatedEnumTypes.OrderBy(t => t.Name).Select(type => new
{
type.Namespace,
type.Name,

4
OpenRA.Mods.Common/UtilityCommands/ExtractTraitDocsCommand.cs
View File

@@ -38,7 +38,7 @@ namespace OpenRA.Mods.Common.UtilityCommands
version = args[1];
var objectCreator = utility.ModData.ObjectCreator;
var traitInfos = objectCreator.GetTypesImplementing<TraitInfo>().OrderBy(t => t.Namespace);
var traitInfos = objectCreator.GetTypesImplementing<TraitInfo>().OrderBy(t => t.Namespace).ThenBy(t => t.Name);
var json = GenerateJson(version, traitInfos, objectCreator);
Console.WriteLine(json);
@@ -96,7 +96,7 @@ namespace OpenRA.Mods.Common.UtilityCommands
})
});
var relatedEnums = relatedEnumTypes.Select(type => new
var relatedEnums = relatedEnumTypes.OrderBy(t => t.Name).Select(type => new
{
type.Namespace,
type.Name,

6
OpenRA.Mods.Common/UtilityCommands/ExtractWeaponDocsCommand.cs
View File

@@ -40,8 +40,8 @@ namespace OpenRA.Mods.Common.UtilityCommands
var objectCreator = utility.ModData.ObjectCreator;
var weaponInfo = new[] { typeof(WeaponInfo) };
var warheads = objectCreator.GetTypesImplementing<IWarhead>().OrderBy(t => t.Namespace);
var projectiles = objectCreator.GetTypesImplementing<IProjectileInfo>().OrderBy(t => t.Namespace);
var warheads = objectCreator.GetTypesImplementing<IWarhead>().OrderBy(t => t.Namespace).ThenBy(t => t.Name);
var projectiles = objectCreator.GetTypesImplementing<IProjectileInfo>().OrderBy(t => t.Namespace).ThenBy(t => t.Name);
var weaponTypes = weaponInfo.Concat(projectiles).Concat(warheads);
@@ -99,7 +99,7 @@ namespace OpenRA.Mods.Common.UtilityCommands
})
});
var relatedEnums = relatedEnumTypes.Select(type => new
var relatedEnums = relatedEnumTypes.OrderBy(t => t.Name).Select(type => new
{
type.Namespace,
type.Name,

5
packaging/format-docs.py
View File

@@ -73,7 +73,8 @@ def format_docs(version, collectionName, types, relatedEnums):
print("###### Inherits from: " + ", ".join([format_type_name(x, is_known_type(x, types)) for x in inheritedTypes]) + '.')
if "RequiresTraits" in currentType and currentType["RequiresTraits"]:
print("###### Requires trait(s): " + ", ".join([format_type_name(x, is_known_type(x, types)) for x in currentType["RequiresTraits"]]) + '.')
formattedRequiredTraits = [format_type_name(x, is_known_type(x, types)) for x in currentType["RequiresTraits"]]
print("###### Requires trait(s): " + ", ".join(sorted(formattedRequiredTraits)) + '.')
if len(currentType["Properties"]) > 0:
print()
@@ -113,7 +114,7 @@ def format_docs(version, collectionName, types, relatedEnums):
values = [f"`{value['Value']}`" for value in relatedEnum["Values"]]
print(f"### {relatedEnum['Name']}")
print(f"Possible values: {', '.join(values)}\n")
distinctReferencingTypes = set(enumReferences[relatedEnum['Name']])
distinctReferencingTypes = sorted(set(enumReferences[relatedEnum['Name']]))
formattedReferencingTypes = [format_type_name(x, is_known_type(x, types)) for x in distinctReferencingTypes]
print(f"Referenced by: {', '.join(formattedReferencingTypes)}\n")