ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Enable SA1626 and fix noncompliance 

"Single-line comments should not use documentation style slashes"
This commit is contained in:
YoshiRulz 2020-06-21 07:38:35 +10:00 committed by zeromus
parent a1aca37476
commit a8bd9733f4
3 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Common.ruleset
View File

@ -557,9 +557,6 @@
<!-- Element documentation should not be copied and pasted --> <!-- Element documentation should not be copied and pasted -->
<Rule Id="SA1625" Action="Hidden" /> <Rule Id="SA1625" Action="Hidden" />
<!-- Single-line comments should not use documentation style slashes -->
<Rule Id="SA1626" Action="Hidden" />
<!-- Documentation text should not be empty --> <!-- Documentation text should not be empty -->
<Rule Id="SA1627" Action="Hidden" /> <Rule Id="SA1627" Action="Hidden" />

15
src/BizHawk.Bizware.BizwareGL/TexAtlas.cs
View File

@ -188,7 +188,7 @@ namespace BizHawk.Bizware.BizwareGL
public RectItem ri; public RectItem ri;
} }
/// Starts a new packing process to a bin of the given dimension. /// <summary>Starts a new packing process to a bin of the given dimension.</summary>
public void Init(int width, int height) public void Init(int width, int height)
{ {
binWidth = width; binWidth = width;
@ -201,16 +201,15 @@ namespace BizHawk.Bizware.BizwareGL
} }
/// Inserts a new rectangle of the given size into the bin. /// <summary>Inserts a new rectangle of the given size into the bin.</summary>
/** Running time is linear to the number of rectangles that have been already packed. /// <returns>A pointer to the node that stores the newly added rectangle, or 0 if it didn't fit.</returns>
@return A pointer to the node that stores the newly added rectangle, or 0 /// <remarks>Running time is linear to the number of rectangles that have been already packed.</remarks>
if it didn't fit. */
public Node Insert(int width, int height) public Node Insert(int width, int height)
{ {
return Insert(root, width, height); return Insert(root, width, height);
} }
/// Computes the ratio of used surface area. /// <summary>Computes the ratio of used surface area.</summary>
float Occupancy() float Occupancy()
{ {
int totalSurfaceArea = binWidth * binHeight; int totalSurfaceArea = binWidth * binHeight;
@ -225,7 +224,7 @@ namespace BizHawk.Bizware.BizwareGL
private int binWidth; private int binWidth;
private int binHeight; private int binHeight;
/// @return The surface area used by the subtree rooted at node. /// <returns>The surface area used by the subtree rooted at node.</returns>
private int UsedSurfaceArea(Node node) private int UsedSurfaceArea(Node node)
{ {
if (node.left != null || node.right != null) if (node.left != null || node.right != null)
@ -244,7 +243,7 @@ namespace BizHawk.Bizware.BizwareGL
} }
/// Inserts a new rectangle in the subtree rooted at the given node. /// <summary>Inserts a new rectangle in the subtree rooted at the given node.</summary>
private Node Insert(Node node, int width, int height) private Node Insert(Node node, int width, int height)
{ {

2
src/BizHawk.Client.EmuHawk/AVOut/JMDWriter.cs
View File

@ -141,7 +141,7 @@ namespace BizHawk.Client.EmuHawk
// output stream is always stereo // output stream is always stereo
private readonly bool _stereo; private readonly bool _stereo;
/// underlying bytestream that is being written to /// <summary>underlying bytestream that is being written to</summary>
private readonly Stream _f; private readonly Stream _f;
/// <exception cref="ArgumentException"><paramref name="f"/> cannot be written to</exception> /// <exception cref="ArgumentException"><paramref name="f"/> cannot be written to</exception>