h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-09-21 18:47:27 +08:00
Code Issues Releases Wiki Activity

Polish xmldocs

Browse Source
This commit is contained in:
Bartłomiej Dach 2023-05-07 19:18:59 +02:00
parent 29ce27098d
commit c930ec97d6
No known key found for this signature in database
3 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
osu.Game/Beatmaps/APIBeatmapMetadataSource.cs
View File

@ -9,6 +9,9 @@ using osu.Game.Online.API.Requests;
namespace osu.Game.Beatmaps namespace osu.Game.Beatmaps
{ {
/// <summary>
/// Performs online metadata lookups using the osu-web API.
/// </summary>
public class APIBeatmapMetadataSource : IOnlineBeatmapMetadataSource public class APIBeatmapMetadataSource : IOnlineBeatmapMetadataSource
{ {
private readonly IAPIProvider api; private readonly IAPIProvider api;

2
osu.Game/Beatmaps/IOnlineBeatmapMetadataSource.cs
View File

@ -6,7 +6,7 @@ using System;
namespace osu.Game.Beatmaps namespace osu.Game.Beatmaps
{ {
/// <summary> /// <summary>
/// Unifying interface for sources of online beatmap metadata. /// Unifying interface for sources of <see cref="OnlineBeatmapMetadata"/>.
/// </summary> /// </summary>
public interface IOnlineBeatmapMetadataSource : IDisposable public interface IOnlineBeatmapMetadataSource : IDisposable
{ {

6
osu.Game/Beatmaps/LocalCachedBeatmapMetadataSource.cs
View File

@ -18,11 +18,9 @@ using SQLitePCL;
namespace osu.Game.Beatmaps namespace osu.Game.Beatmaps
{ {
/// <summary> /// <summary>
/// /// Performs online metadata lookups using a copy of a database containing metadata for a large subset of beatmaps (stored to <see cref="cache_database_name"/>).
/// The database will be asynchronously downloaded - if not already present locally - when this component is constructed.
/// </summary> /// </summary>
/// <remarks>
/// On creating the component, a copy of a database containing metadata for a large subset of beatmaps (stored to <see cref="cache_database_name"/>) will be downloaded if not already present locally.
/// </remarks>
public class LocalCachedBeatmapMetadataSource : IOnlineBeatmapMetadataSource public class LocalCachedBeatmapMetadataSource : IOnlineBeatmapMetadataSource
{ {
private readonly Storage storage; private readonly Storage storage;