Review StyleCop rules.

- Enforce SA1604 ElementDocumentationShouldHaveSummary.
- Enforce SA1629 DocumentationTextShouldEndWithAPeriod.
- Turn off some rules covered by IDExxxx rules.
- Remaining rules are treated as part of OpenRA style.
This commit is contained in:
RoosterDragon
2023-03-18 09:29:56 +00:00
committed by Gustas
parent 88ba974ea5
commit bcfa0c9ae9
42 changed files with 120 additions and 110 deletions

View File

@@ -19,11 +19,11 @@ namespace OpenRA.Mods.Common.UpdateRules
public abstract string Description { get; }
/// <summary>Defines a transformation that is run on each top-level node in a yaml file set.</summary>
/// <returns>An enumerable of manual steps to be run by the user</returns>
/// <returns>An enumerable of manual steps to be run by the user.</returns>
public delegate IEnumerable<string> TopLevelNodeTransform(ModData modData, MiniYamlNode node);
/// <summary>Defines a transformation that is run on each widget node in a chrome yaml file set.</summary>
/// <returns>An enumerable of manual steps to be run by the user</returns>
/// <returns>An enumerable of manual steps to be run by the user.</returns>
public delegate IEnumerable<string> ChromeNodeTransform(ModData modData, MiniYamlNode widgetNode);
public virtual IEnumerable<string> UpdateActorNode(ModData modData, MiniYamlNode actorNode) { yield break; }