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

Review StyleCop rules.

Browse Source 
- 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
Download Patch File Download Diff File Expand all files Collapse all files

26
OpenRA.Game/Network/GameServer.cs
View File

@@ -61,34 +61,34 @@ namespace OpenRA.Network
public const int ProtocolVersion = 2;
/// <summary>Online game number or -1 for LAN games</summary>
/// <summary>Online game number or -1 for LAN games.</summary>
public readonly int Id = -1;
/// <summary>Name of the server</summary>
/// <summary>Name of the server.</summary>
public readonly string Name = null;
/// <summary>ip:port string to connect to.</summary>
public readonly string Address = null;
/// <summary>Port of the server</summary>
/// <summary>Port of the server.</summary>
public readonly int Port = 0;
/// <summary>The current state of the server (waiting/playing/completed)</summary>
/// <summary>The current state of the server (waiting/playing/completed).</summary>
public readonly int State = 0;
/// <summary>The number of slots available for non-bot players</summary>
/// <summary>The number of slots available for non-bot players.</summary>
public readonly int MaxPlayers = 0;
/// <summary>UID of the map</summary>
/// <summary>UID of the map.</summary>
public readonly string Map = null;
/// <summary>Mod ID</summary>
/// <summary>Mod ID.</summary>
public readonly string Mod = "";
/// <summary>Mod Version</summary>
/// <summary>Mod Version.</summary>
public readonly string Version = "";
/// <summary>Human-readable mod title</summary>
/// <summary>Human-readable mod title.</summary>
public readonly string ModTitle = "";
/// <summary>URL to show in game listings for custom/unknown mods.</summary>
@@ -100,13 +100,13 @@ namespace OpenRA.Network
/// <summary>GeoIP resolved server location.</summary>
public readonly string Location = "";
/// <summary>Password protected</summary>
/// <summary>Password protected.</summary>
public readonly bool Protected = false;
/// <summary>Players must be authenticated with the OpenRA forum</summary>
/// <summary>Players must be authenticated with the OpenRA forum.</summary>
public readonly bool Authentication = false;
/// <summary>UTC datetime string when the game changed to the Playing state</summary>
/// <summary>UTC datetime string when the game changed to the Playing state.</summary>
public readonly string Started = null;
/// <summary>Number of non-spectator, non-bot players. Only defined if GameServer is parsed from yaml.</summary>
@@ -132,7 +132,7 @@ namespace OpenRA.Network
[FieldLoader.LoadUsing(nameof(LoadClients))]
public readonly GameClient[] Clients;
/// <summary>The list of spawnpoints that are disabled for this game</summary>
/// <summary>The list of spawnpoints that are disabled for this game.</summary>
public readonly int[] DisabledSpawnPoints = Array.Empty<int>();
public string ModLabel => $"{ModTitle} ({Version})";