Update docs

Author: erri120

src/NexusMods.Abstractions.Loadouts.Synchronizers/ALoadoutSynchronizer.cs

@@ -1525,7 +1525,7 @@ public async Task<bool> ReindexState(GameInstallation installation, ITransaction
         var indexGameResult = await _gameLocationsService.IndexGame(
             installation: installation,
             previousDiskState: previousState,
-            filter: LocationsFilter,
+            filter: GamePathFilter,
             cancellationToken: CancellationToken.None
         );
 
@@ -1610,7 +1610,7 @@ private LoadoutGameFilesGroup.New CreateLoadoutGameFilesGroup(LoadoutId loadout,
     /// Files ignored by this method will not be included in the sync tree. Prefer not including
     /// the path in the first place instead of using this method.
     /// </remarks>
-    protected virtual ILocationsFilter LocationsFilter { get; } = Synchronizers.LocationsFilter.Empty;
+    protected virtual IGamePathFilter GamePathFilter { get; } = Synchronizers.GamePathFilters.Empty;
 
     /// <summary>
     /// Gets a set of files intrinsic to this game. Such as mod order files, preference files, etc.

src/NexusMods.Abstractions.Loadouts.Synchronizers/IGameLocationsService.cs

@@ -21,35 +21,38 @@ public record IndexGameResult(
     FrozenSet<GamePath> RemovedFiles
 );
 
+/// <summary>
+/// Service responsible for handling operations on game locations/installations.
+/// </summary>
 [PublicAPI]
 public interface IGameLocationsService
 {
     Task<IndexGameResult> IndexGame(
         GameInstallation installation,
         FrozenDictionary<GamePath, DiskStateEntry.ReadOnly> previousDiskState,
-        ILocationsFilter filter,
+        IGamePathFilter filter,
         CancellationToken cancellationToken = default
     );
 
     // Task RemoveEmptyDirectories(GameInstallation installation, CancellationToken cancellationToken = default);
 }
 
 [PublicAPI]
-public interface ILocationsFilter
+public interface IGamePathFilter
 {
     bool ShouldFilter(GamePath gamePath);
 }
 
-public static class LocationsFilter
+public static class GamePathFilters
 {
-    public static readonly ILocationsFilter Empty = new EmptyFilter();
+    public static readonly IGamePathFilter Empty = new EmptyFilter();
 
-    public static ILocationsFilter Create(Func<GamePath, bool> predicate)
+    public static IGamePathFilter Create(Func<GamePath, bool> predicate)
     {
         return new PredicateFilter(predicate);
     }
 
-    private class PredicateFilter : ILocationsFilter
+    private class PredicateFilter : IGamePathFilter
     {
         private readonly Func<GamePath, bool> _predicate;
 
@@ -61,7 +64,7 @@ public PredicateFilter(Func<GamePath, bool> predicate)
         public bool ShouldFilter(GamePath gamePath) => _predicate(gamePath);
     }
 
-    private class EmptyFilter : ILocationsFilter
+    private class EmptyFilter : IGamePathFilter
     {
         public bool ShouldFilter(GamePath gamePath) => false;
     }

src/NexusMods.Backend/Game/GameLocationsService.cs

@@ -30,7 +30,7 @@ public GameLocationsService(IServiceProvider serviceProvider)
     public async Task<IndexGameResult> IndexGame(
         GameInstallation installation,
         FrozenDictionary<GamePath, DiskStateEntry.ReadOnly> previousDiskState,
-        ILocationsFilter filter,
+        IGamePathFilter filter,
         CancellationToken outerToken = default)
     {
         var topLevelLocations = installation.LocationsRegister.GetTopLevelLocations();

src/NexusMods.Games.CreationEngine/ACreationEngineSynchronizer.cs

@@ -24,7 +24,7 @@ protected ACreationEngineSynchronizer(IServiceProvider provider, ICreationEngine
 
 
     private static readonly GamePath SavesPath = new GamePath(LocationId.Preferences, "Saves");
-    protected override ILocationsFilter LocationsFilter { get; } = NexusMods.Abstractions.Loadouts.Synchronizers.LocationsFilter.Create(path => path.InFolder(SavesPath));
+    protected override IGamePathFilter GamePathFilter { get; } = NexusMods.Abstractions.Loadouts.Synchronizers.GamePathFilters.Create(path => path.InFolder(SavesPath));
 
     public override Dictionary<GamePath, IIntrinsicFile> IntrinsicFiles(Loadout.ReadOnly _) => _intrinsicFiles;
 

src/NexusMods.Games.Larian/BaldursGate3/BaldursGate3Synchronizer.cs

@@ -19,7 +19,7 @@ public BaldursGate3Synchronizer(IServiceProvider provider) : base(provider)
         _settings = settingsManager.Get<BaldursGate3Settings>();
     }
 
-    protected override ILocationsFilter LocationsFilter { get; } = Abstractions.Loadouts.Synchronizers.LocationsFilter.Create(path =>
+    protected override IGamePathFilter GamePathFilter { get; } = Abstractions.Loadouts.Synchronizers.GamePathFilters.Create(path =>
     {
         // ignore all files inside the public player profiles directory except the modsettings.lsx file
         if (path.InFolder(PublicPlayerProfiles)) return !path.Equals(ModSettingsFile);