1
0
mirror of https://github.com/ppy/osu.git synced 2025-01-27 20:32:54 +08:00

Move and correct xmldoc to interfaces

This commit is contained in:
Dean Herbert 2022-06-14 20:00:16 +09:00
parent 84e526a2d9
commit e96c5ce703
2 changed files with 9 additions and 9 deletions

View File

@ -12,14 +12,22 @@ namespace osu.Game.Database
public interface ICanAcceptFiles public interface ICanAcceptFiles
{ {
/// <summary> /// <summary>
/// Import the specified paths. /// Import one or more items from filesystem <paramref name="paths"/>.
/// </summary> /// </summary>
/// <remarks>
/// This will be treated as a low priority batch import if more than one path is specified.
/// This will post notifications tracking progress.
/// </remarks>
/// <param name="paths">The files which should be imported.</param> /// <param name="paths">The files which should be imported.</param>
Task Import(params string[] paths); Task Import(params string[] paths);
/// <summary> /// <summary>
/// Import the specified files from the given import tasks. /// Import the specified files from the given import tasks.
/// </summary> /// </summary>
/// <remarks>
/// This will be treated as a low priority batch import if more than one path is specified.
/// This will post notifications tracking progress.
/// </remarks>
/// <param name="tasks">The import tasks from which the files should be imported.</param> /// <param name="tasks">The import tasks from which the files should be imported.</param>
Task Import(params ImportTask[] tasks); Task Import(params ImportTask[] tasks);

View File

@ -78,14 +78,6 @@ namespace osu.Game.Stores
Files = new RealmFileStore(realm, storage); Files = new RealmFileStore(realm, storage);
} }
/// <summary>
/// Import one or more <typeparamref name="TModel"/> items from filesystem <paramref name="paths"/>.
/// </summary>
/// <remarks>
/// This will be treated as a low priority import if more than one path is specified; use <see cref="Import(ImportTask[])"/> to always import at standard priority.
/// This will post notifications tracking progress.
/// </remarks>
/// <param name="paths">One or more archive locations on disk.</param>
public Task Import(params string[] paths) public Task Import(params string[] paths)
{ {
var notification = new ProgressNotification { State = ProgressNotificationState.Active }; var notification = new ProgressNotification { State = ProgressNotificationState.Active };