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:
@@ -72,7 +72,7 @@ namespace OpenRA
|
||||
return uv.V * Size.Width + uv.U;
|
||||
}
|
||||
|
||||
/// <summary>Gets or sets the <see cref="CellLayer"/> using cell coordinates</summary>
|
||||
/// <summary>Gets or sets the <see cref="CellLayer"/> using cell coordinates.</summary>
|
||||
public T this[CPos cell]
|
||||
{
|
||||
get => Entries[Index(cell)];
|
||||
@@ -85,7 +85,7 @@ namespace OpenRA
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Gets or sets the layer contents using raw map coordinates (not CPos!)</summary>
|
||||
/// <summary>Gets or sets the layer contents using raw map coordinates (not CPos!).</summary>
|
||||
public T this[MPos uv]
|
||||
{
|
||||
get => Entries[Index(uv)];
|
||||
|
||||
@@ -43,13 +43,13 @@ namespace OpenRA
|
||||
Array.Copy(anotherLayer.Entries, Entries, Entries.Length);
|
||||
}
|
||||
|
||||
/// <summary>Clears the layer contents with their default value</summary>
|
||||
/// <summary>Clears the layer contents with their default value.</summary>
|
||||
public virtual void Clear()
|
||||
{
|
||||
Array.Clear(Entries, 0, Entries.Length);
|
||||
}
|
||||
|
||||
/// <summary>Clears the layer contents with a known value</summary>
|
||||
/// <summary>Clears the layer contents with a known value.</summary>
|
||||
public virtual void Clear(T clearValue)
|
||||
{
|
||||
Array.Fill(Entries, clearValue);
|
||||
|
||||
@@ -155,7 +155,7 @@ namespace OpenRA
|
||||
public const int CurrentMapFormat = 12;
|
||||
const short InvalidCachedTerrainIndex = -1;
|
||||
|
||||
/// <summary>Defines the order of the fields in map.yaml</summary>
|
||||
/// <summary>Defines the order of the fields in map.yaml.</summary>
|
||||
static readonly MapField[] YamlFields =
|
||||
{
|
||||
new MapField("MapFormat"),
|
||||
@@ -993,7 +993,7 @@ namespace OpenRA
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The size of the map Height step in world units
|
||||
/// The size of the map Height step in world units.
|
||||
/// </summary>
|
||||
/// RectangularIsometric defines 1024 units along the diagonal axis,
|
||||
/// giving a half-tile height step of sqrt(2) * 512
|
||||
|
||||
@@ -43,7 +43,7 @@ namespace OpenRA
|
||||
readonly List<MapDirectoryTracker> mapDirectoryTrackers = new List<MapDirectoryTracker>();
|
||||
|
||||
/// <summary>
|
||||
/// The most recently modified or loaded map at runtime
|
||||
/// The most recently modified or loaded map at runtime.
|
||||
/// </summary>
|
||||
public string LastModifiedMap { get; private set; } = null;
|
||||
readonly Dictionary<string, string> mapUpdates = new Dictionary<string, string>();
|
||||
@@ -51,7 +51,7 @@ namespace OpenRA
|
||||
string lastLoadedLastModifiedMap;
|
||||
|
||||
/// <summary>
|
||||
/// If LastModifiedMap was picked already, returns a null
|
||||
/// If LastModifiedMap was picked already, returns a null.
|
||||
/// </summary>
|
||||
public string PickLastModifiedMap(MapVisibility visibility)
|
||||
{
|
||||
|
||||
@@ -63,7 +63,7 @@ namespace OpenRA
|
||||
|
||||
public class MapPreview : IDisposable, IReadOnlyFileSystem
|
||||
{
|
||||
/// <summary>Wrapper that enables map data to be replaced in an atomic fashion</summary>
|
||||
/// <summary>Wrapper that enables map data to be replaced in an atomic fashion.</summary>
|
||||
class InnerData
|
||||
{
|
||||
public int MapFormat;
|
||||
|
||||
@@ -36,7 +36,7 @@ namespace OpenRA
|
||||
/// <summary>
|
||||
/// Sets the "Home" location, which can be used by traits and scripts to e.g. set the initial camera
|
||||
/// location or choose the map edge for reinforcements.
|
||||
/// This will usually be overridden for client (lobby slot) players with a location based on the Spawn index
|
||||
/// This will usually be overridden for client (lobby slot) players with a location based on the Spawn index.
|
||||
/// </summary>
|
||||
public CPos HomeLocation = CPos.Zero;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user