RepoMirrors
/
osu
mirror of https://github.com/ppy/osu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
osu.Game/Database/ICanAcceptFiles.cs
View File

@ -12,14 +12,22 @@ namespace osu.Game.Database
public interface ICanAcceptFiles
{
/// <summary>
/// Import the specified paths.
/// Import one or more items from filesystem <paramref name="paths"/>.
/// </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>
Task Import(params string[] paths);
/// <summary>
/// Import the specified files from the given import tasks.
/// </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>
Task Import(params ImportTask[] tasks);

8
osu.Game/Stores/RealmArchiveModelImporter.cs
View File

@ -78,14 +78,6 @@ protected RealmArchiveModelImporter(Storage storage, RealmAccess realm)
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)
{
var notification = new ProgressNotification { State = ProgressNotificationState.Active };