diff --git a/Directory.Build.props b/Directory.Build.props index 099fabfcb..fb2120b7a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -5,6 +5,10 @@ true enable + + true + $(NoWarn);CS1591 + osu-framework.licenseheader diff --git a/osu.Framework.Templates/templates/template-empty/Directory.Build.props b/osu.Framework.Templates/templates/template-empty/Directory.Build.props index 8824b1f46..74d05ff69 100644 --- a/osu.Framework.Templates/templates/template-empty/Directory.Build.props +++ b/osu.Framework.Templates/templates/template-empty/Directory.Build.props @@ -3,4 +3,8 @@ $(MSBuildThisFileDirectory)app.manifest + + true + $(NoWarn);CS1591 + diff --git a/osu.Framework.Templates/templates/template-flappy/Directory.Build.props b/osu.Framework.Templates/templates/template-flappy/Directory.Build.props index 8824b1f46..74d05ff69 100644 --- a/osu.Framework.Templates/templates/template-flappy/Directory.Build.props +++ b/osu.Framework.Templates/templates/template-flappy/Directory.Build.props @@ -3,4 +3,8 @@ $(MSBuildThisFileDirectory)app.manifest + + true + $(NoWarn);CS1591 + diff --git a/osu.Framework/Extensions/OSPlatformExtensions.cs b/osu.Framework/Extensions/OSPlatformExtensions.cs index 277e619bc..f9b437045 100644 --- a/osu.Framework/Extensions/OSPlatformExtensions.cs +++ b/osu.Framework/Extensions/OSPlatformExtensions.cs @@ -12,7 +12,7 @@ namespace osu.Framework.Extensions { /// /// Checks whether this is supported on the current runtime platform as specified by - /// and . + /// [SupportedOSPlatform] and [UnsupportedOSPlatform]. /// /// The to check the attributes of. /// true if this is supported, false otherwise. @@ -34,7 +34,7 @@ namespace osu.Framework.Extensions } /// - /// Returns whether the provided matches the current (runtime) platform. + /// Returns whether the provided [OSPlatformAttribute] matches the current (runtime) platform. /// /// This is currently a naive check which doesn't support specific OS versions. private static bool matchesCurrentPlatform(OSPlatformAttribute attribute) diff --git a/osu.Framework/Graphics/Veldrid/Batches/VeldridVertexBatch.cs b/osu.Framework/Graphics/Veldrid/Batches/VeldridVertexBatch.cs index c8f499f74..778b9a2ba 100644 --- a/osu.Framework/Graphics/Veldrid/Batches/VeldridVertexBatch.cs +++ b/osu.Framework/Graphics/Veldrid/Batches/VeldridVertexBatch.cs @@ -19,7 +19,7 @@ namespace osu.Framework.Graphics.Veldrid.Batches /// Most documentation recommends that three buffers are used to avoid contention. /// /// We already have a triple buffer (see ) governing draw nodes. - /// In theory we could set this to two, but there's also a global usage of a vertex batch in (see ). + /// In theory we could set this to two, but there's also a global usage of a vertex batch in (see ). /// /// So this is for now an unfortunate memory overhead. Further work could be done to provide /// these in a way they were not created per draw-node, reducing buffer overhead from 9 to 3. diff --git a/osu.Framework/Graphics/Veldrid/Shaders/VeldridShaderPart.cs b/osu.Framework/Graphics/Veldrid/Shaders/VeldridShaderPart.cs index 6cabf12ee..2c61e7aeb 100644 --- a/osu.Framework/Graphics/Veldrid/Shaders/VeldridShaderPart.cs +++ b/osu.Framework/Graphics/Veldrid/Shaders/VeldridShaderPart.cs @@ -142,7 +142,7 @@ namespace osu.Framework.Graphics.Veldrid.Shaders } /// - /// Creates a based off this shader with a list of attributes passed through as input & output. + /// Creates a based off this shader with a list of attributes passed through as input & output. /// Attributes from the list that are already defined in this shader will be ignored. /// /// @@ -154,7 +154,7 @@ namespace osu.Framework.Graphics.Veldrid.Shaders /// This creates a new rather than altering this existing instance since this is cached at a level and should remain immutable. /// /// - /// The list of attributes to include in the shader as input & output. + /// The list of attributes to include in the shader as input & output. public VeldridShaderPart WithPassthroughInput(IReadOnlyList attributes) { string result = code; diff --git a/osu.Framework/Utils/PathApproximator.cs b/osu.Framework/Utils/PathApproximator.cs index 21a2cfdfd..1609ff6f1 100644 --- a/osu.Framework/Utils/PathApproximator.cs +++ b/osu.Framework/Utils/PathApproximator.cs @@ -308,7 +308,7 @@ namespace osu.Framework.Utils /// The rate of optimization. Larger values converge faster but can be unstable. /// The B1 parameter for the Adam optimizer. Between 0 and 1. /// The B2 parameter for the Adam optimizer. Between 0 and 1. - /// The initial bezier control points to use before optimization. The length of this list should be equal to . + /// The initial bezier control points to use before optimization. The length of this list should be equal to . /// Mask determining which control point positions are fixed and cannot be changed by the optimiser. /// A List of vectors representing the bezier control points. public static List PiecewiseLinearToBezier(ReadOnlySpan inputPath, @@ -337,7 +337,7 @@ namespace osu.Framework.Utils /// The rate of optimization. Larger values converge faster but can be unstable. /// The B1 parameter for the Adam optimizer. Between 0 and 1. /// The B2 parameter for the Adam optimizer. Between 0 and 1. - /// The initial B-spline control points to use before optimization. The length of this list should be equal to . + /// The initial B-spline control points to use before optimization. The length of this list should be equal to . /// Mask determining which control point positions are fixed and cannot be changed by the optimiser. /// A List of vectors representing the B-spline control points. public static List PiecewiseLinearToBSpline(ReadOnlySpan inputPath,