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

Added referencing types to enum definitions

Browse Source
This commit is contained in:
penev92
2022-09-13 18:57:40 +03:00
committed by Matthias Mailänder
parent 07b9c941b4
commit 6b98a75658
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packaging/format-docs.py
View File

@@ -37,6 +37,7 @@ def format_docs(version, collectionName, types, relatedEnums):
# Map the `relatedEnums` collection to a list of strings. # Map the `relatedEnums` collection to a list of strings.
enumNames = [enum['Name'] for enum in relatedEnums] enumNames = [enum['Name'] for enum in relatedEnums]
enumReferences = OrderedDict()
title = "" title = ""
explanation = "" explanation = ""
@@ -86,6 +87,10 @@ def format_docs(version, collectionName, types, relatedEnums):
typeName = prop["UserFriendlyType"] typeName = prop["UserFriendlyType"]
if prop["InternalType"] in enumNames: if prop["InternalType"] in enumNames:
typeName = format_type_name(prop["InternalType"], True) typeName = format_type_name(prop["InternalType"], True)
if prop["InternalType"] in enumReferences:
enumReferences[prop["InternalType"]].append(currentType["Name"])
else:
enumReferences[prop["InternalType"]] = [currentType["Name"]]
if "OtherAttributes" in prop: if "OtherAttributes" in prop:
attributes = [] attributes = []
@@ -108,6 +113,9 @@ def format_docs(version, collectionName, types, relatedEnums):
values = [f"`{value['Value']}`" for value in relatedEnum["Values"]] values = [f"`{value['Value']}`" for value in relatedEnum["Values"]]
print(f"### {relatedEnum['Name']}") print(f"### {relatedEnum['Name']}")
print(f"Possible values: {', '.join(values)}\n") print(f"Possible values: {', '.join(values)}\n")
distinctReferencingTypes = 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")
if __name__ == "__main__": if __name__ == "__main__":
input_stream = io.TextIOWrapper(sys.stdin.buffer, encoding='utf-8-sig') input_stream = io.TextIOWrapper(sys.stdin.buffer, encoding='utf-8-sig')