From e12d01cdb6264abf030a2c30db0a2853eb85a183 Mon Sep 17 00:00:00 2001 From: Matt Nadareski Date: Tue, 28 Jul 2020 13:29:14 -0700 Subject: [PATCH] Add comprehensive remark --- SabreTools.Library/DatFiles/Filter.cs | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/SabreTools.Library/DatFiles/Filter.cs b/SabreTools.Library/DatFiles/Filter.cs index 35d31586..8f2f3f2c 100644 --- a/SabreTools.Library/DatFiles/Filter.cs +++ b/SabreTools.Library/DatFiles/Filter.cs @@ -1965,6 +1965,16 @@ namespace SabreTools.Library.DatFiles /// Filter a DAT using 1G1R logic given an ordered set of regions /// /// DatFile to filter + /// + /// In the most technical sense, the way that the region list is being used does not + /// confine its values to be just regions. Since it's essentially acting like a + /// specialized version of the machine name filter, anything that is usually encapsulated + /// in parenthesis would be matched on, including disc numbers, languages, editions, + /// and anything else commonly used. Please note that, unlike other existing 1G1R + /// solutions, this does not have the ability to contain custom mappings of parent + /// to clone sets based on name, nor does it have the ability to match on the + /// Release DatItem type. + /// private void OneGamePerRegion(DatFile datFile) { // For sake of ease, the first thing we want to do is bucket by game