1
0
mirror of https://github.com/ppy/osu.git synced 2024-09-21 18:47:27 +08:00

Remove empty <returns> xmldoc

This commit is contained in:
Dean Herbert 2021-04-12 17:46:14 +09:00
parent 5d942e92f3
commit b5954a55ad
17 changed files with 0 additions and 18 deletions

View File

@ -69,7 +69,6 @@ namespace osu.Desktop
/// Allow a maximum of one unhandled exception, per second of execution. /// Allow a maximum of one unhandled exception, per second of execution.
/// </summary> /// </summary>
/// <param name="arg"></param> /// <param name="arg"></param>
/// <returns></returns>
private static bool handleException(Exception arg) private static bool handleException(Exception arg)
{ {
bool continueExecution = Interlocked.Decrement(ref allowableExceptions) >= 0; bool continueExecution = Interlocked.Decrement(ref allowableExceptions) >= 0;

View File

@ -482,7 +482,6 @@ namespace osu.Game.Rulesets.Mania.Beatmaps.Patterns.Legacy
/// Retrieves the sample info list at a point in time. /// Retrieves the sample info list at a point in time.
/// </summary> /// </summary>
/// <param name="time">The time to retrieve the sample info list from.</param> /// <param name="time">The time to retrieve the sample info list from.</param>
/// <returns></returns>
private IList<HitSampleInfo> sampleInfoListAt(int time) => nodeSamplesAt(time)?.First() ?? HitObject.Samples; private IList<HitSampleInfo> sampleInfoListAt(int time) => nodeSamplesAt(time)?.First() ?? HitObject.Samples;
/// <summary> /// <summary>

View File

@ -141,7 +141,6 @@ namespace osu.Game.Tournament
/// <summary> /// <summary>
/// Add missing player info based on user IDs. /// Add missing player info based on user IDs.
/// </summary> /// </summary>
/// <returns></returns>
private bool addPlayers() private bool addPlayers()
{ {
bool addedInfo = false; bool addedInfo = false;

View File

@ -44,7 +44,6 @@ namespace osu.Game.Beatmaps
/// <summary> /// <summary>
/// Returns statistics for the <see cref="HitObjects"/> contained in this beatmap. /// Returns statistics for the <see cref="HitObjects"/> contained in this beatmap.
/// </summary> /// </summary>
/// <returns></returns>
IEnumerable<BeatmapStatistic> GetStatistics(); IEnumerable<BeatmapStatistic> GetStatistics();
/// <summary> /// <summary>

View File

@ -22,7 +22,6 @@ namespace osu.Game.Configuration
/// </summary> /// </summary>
/// <param name="rulesetId">The ruleset's internal ID.</param> /// <param name="rulesetId">The ruleset's internal ID.</param>
/// <param name="variant">An optional variant.</param> /// <param name="variant">An optional variant.</param>
/// <returns></returns>
public List<DatabasedSetting> Query(int? rulesetId = null, int? variant = null) => public List<DatabasedSetting> Query(int? rulesetId = null, int? variant = null) =>
ContextFactory.Get().DatabasedSetting.Where(b => b.RulesetID == rulesetId && b.Variant == variant).ToList(); ContextFactory.Get().DatabasedSetting.Where(b => b.RulesetID == rulesetId && b.Variant == variant).ToList();

View File

@ -346,7 +346,6 @@ namespace osu.Game.Graphics.Backgrounds
/// such that the smaller triangles appear on top. /// such that the smaller triangles appear on top.
/// </summary> /// </summary>
/// <param name="other"></param> /// <param name="other"></param>
/// <returns></returns>
public int CompareTo(TriangleParticle other) => other.Scale.CompareTo(Scale); public int CompareTo(TriangleParticle other) => other.Scale.CompareTo(Scale);
} }
} }

View File

@ -22,7 +22,6 @@ namespace osu.Game.IO.Serialization
/// <summary> /// <summary>
/// Creates the default <see cref="JsonSerializerSettings"/> that should be used for all <see cref="IJsonSerializable"/>s. /// Creates the default <see cref="JsonSerializerSettings"/> that should be used for all <see cref="IJsonSerializable"/>s.
/// </summary> /// </summary>
/// <returns></returns>
public static JsonSerializerSettings CreateGlobalSettings() => new JsonSerializerSettings public static JsonSerializerSettings CreateGlobalSettings() => new JsonSerializerSettings
{ {
ReferenceLoopHandling = ReferenceLoopHandling.Ignore, ReferenceLoopHandling = ReferenceLoopHandling.Ignore,

View File

@ -85,7 +85,6 @@ namespace osu.Game.Input
/// </summary> /// </summary>
/// <param name="rulesetId">The ruleset's internal ID.</param> /// <param name="rulesetId">The ruleset's internal ID.</param>
/// <param name="variant">An optional variant.</param> /// <param name="variant">An optional variant.</param>
/// <returns></returns>
public List<DatabasedKeyBinding> Query(int? rulesetId = null, int? variant = null) => public List<DatabasedKeyBinding> Query(int? rulesetId = null, int? variant = null) =>
ContextFactory.Get().DatabasedKeyBinding.Where(b => b.RulesetID == rulesetId && b.Variant == variant).ToList(); ContextFactory.Get().DatabasedKeyBinding.Where(b => b.RulesetID == rulesetId && b.Variant == variant).ToList();

View File

@ -574,7 +574,6 @@ namespace osu.Game.Rulesets.Objects.Drawables
/// Calculate the position to be used for sample playback at a specified X position (0..1). /// Calculate the position to be used for sample playback at a specified X position (0..1).
/// </summary> /// </summary>
/// <param name="position">The lookup X position. Generally should be <see cref="SamplePlaybackPosition"/>.</param> /// <param name="position">The lookup X position. Generally should be <see cref="SamplePlaybackPosition"/>.</param>
/// <returns></returns>
protected double CalculateSamplePlaybackBalance(double position) protected double CalculateSamplePlaybackBalance(double position)
{ {
const float balance_adjust_amount = 0.4f; const float balance_adjust_amount = 0.4f;

View File

@ -147,7 +147,6 @@ namespace osu.Game.Rulesets.Objects
/// to 1 (end of the path). /// to 1 (end of the path).
/// </summary> /// </summary>
/// <param name="progress">Ranges from 0 (beginning of the path) to 1 (end of the path).</param> /// <param name="progress">Ranges from 0 (beginning of the path) to 1 (end of the path).</param>
/// <returns></returns>
public Vector2 PositionAt(double progress) public Vector2 PositionAt(double progress)
{ {
ensureValid(); ensureValid();
@ -161,7 +160,6 @@ namespace osu.Game.Rulesets.Objects
/// The first point has a PathType which all other points inherit. /// The first point has a PathType which all other points inherit.
/// </summary> /// </summary>
/// <param name="controlPoint">One of the control points in the segment.</param> /// <param name="controlPoint">One of the control points in the segment.</param>
/// <returns></returns>
public List<PathControlPoint> PointsInSegment(PathControlPoint controlPoint) public List<PathControlPoint> PointsInSegment(PathControlPoint controlPoint)
{ {
bool found = false; bool found = false;

View File

@ -146,7 +146,6 @@ namespace osu.Game.Rulesets
/// <param name="beatmap">The beatmap to create the hit renderer for.</param> /// <param name="beatmap">The beatmap to create the hit renderer for.</param>
/// <param name="mods">The <see cref="Mod"/>s to apply.</param> /// <param name="mods">The <see cref="Mod"/>s to apply.</param>
/// <exception cref="BeatmapInvalidForRulesetException">Unable to successfully load the beatmap to be usable with this ruleset.</exception> /// <exception cref="BeatmapInvalidForRulesetException">Unable to successfully load the beatmap to be usable with this ruleset.</exception>
/// <returns></returns>
public abstract DrawableRuleset CreateDrawableRulesetWith(IBeatmap beatmap, IReadOnlyList<Mod> mods = null); public abstract DrawableRuleset CreateDrawableRulesetWith(IBeatmap beatmap, IReadOnlyList<Mod> mods = null);
/// <summary> /// <summary>

View File

@ -62,7 +62,6 @@ namespace osu.Game.Rulesets.Scoring
/// <summary> /// <summary>
/// Retrieves a mapping of <see cref="HitResult"/>s to their timing windows for all allowed <see cref="HitResult"/>s. /// Retrieves a mapping of <see cref="HitResult"/>s to their timing windows for all allowed <see cref="HitResult"/>s.
/// </summary> /// </summary>
/// <returns></returns>
public IEnumerable<(HitResult result, double length)> GetAllAvailableWindows() public IEnumerable<(HitResult result, double length)> GetAllAvailableWindows()
{ {
for (var result = HitResult.Meh; result <= HitResult.Perfect; ++result) for (var result = HitResult.Meh; result <= HitResult.Perfect; ++result)

View File

@ -12,7 +12,6 @@ namespace osu.Game.Screens.Edit.Components.RadioButtons
/// <summary> /// <summary>
/// Whether this <see cref="RadioButton"/> is selected. /// Whether this <see cref="RadioButton"/> is selected.
/// </summary> /// </summary>
/// <returns></returns>
public readonly BindableBool Selected; public readonly BindableBool Selected;
/// <summary> /// <summary>

View File

@ -226,7 +226,6 @@ namespace osu.Game.Screens.Ranking
/// <summary> /// <summary>
/// Enumerates all <see cref="ScorePanel"/>s contained in this <see cref="ScorePanelList"/>. /// Enumerates all <see cref="ScorePanel"/>s contained in this <see cref="ScorePanelList"/>.
/// </summary> /// </summary>
/// <returns></returns>
public IEnumerable<ScorePanel> GetScorePanels() => flow.Select(t => t.Panel); public IEnumerable<ScorePanel> GetScorePanels() => flow.Select(t => t.Panel);
/// <summary> /// <summary>

View File

@ -189,7 +189,6 @@ namespace osu.Game.Tests.Beatmaps
/// <summary> /// <summary>
/// Creates the <see cref="Ruleset"/> applicable to this <see cref="BeatmapConversionTest{TConvertMapping,TConvertValue}"/>. /// Creates the <see cref="Ruleset"/> applicable to this <see cref="BeatmapConversionTest{TConvertMapping,TConvertValue}"/>.
/// </summary> /// </summary>
/// <returns></returns>
protected abstract Ruleset CreateRuleset(); protected abstract Ruleset CreateRuleset();
private class ConvertResult private class ConvertResult

View File

@ -17,7 +17,6 @@ namespace osu.Game.Tests.Beatmaps
/// <summary> /// <summary>
/// Creates the <see cref="Ruleset"/> whose legacy mod conversion is to be tested. /// Creates the <see cref="Ruleset"/> whose legacy mod conversion is to be tested.
/// </summary> /// </summary>
/// <returns></returns>
protected abstract Ruleset CreateRuleset(); protected abstract Ruleset CreateRuleset();
protected void TestFromLegacy(LegacyMods legacyMods, Type[] expectedMods) protected void TestFromLegacy(LegacyMods legacyMods, Type[] expectedMods)

View File

@ -37,7 +37,6 @@ namespace osu.Game.Utils
/// Shortcase for: <c>optional.HasValue ? optional.Value : fallback</c>. /// Shortcase for: <c>optional.HasValue ? optional.Value : fallback</c>.
/// </remarks> /// </remarks>
/// <param name="fallback">The fallback value to return if <see cref="HasValue"/> is <c>false</c>.</param> /// <param name="fallback">The fallback value to return if <see cref="HasValue"/> is <c>false</c>.</param>
/// <returns></returns>
public T GetOr(T fallback) => HasValue ? Value : fallback; public T GetOr(T fallback) => HasValue ? Value : fallback;
public static implicit operator Optional<T>(T value) => new Optional<T>(value); public static implicit operator Optional<T>(T value) => new Optional<T>(value);