From e8701f46f115348b502686916cc9f27fbbd5df01 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Mon, 28 Feb 2022 21:39:21 +0100
Subject: [PATCH] Add xmldoc to `Filter` to explain usage

---
 osu.Game/Overlays/Mods/ModColumn.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/osu.Game/Overlays/Mods/ModColumn.cs b/osu.Game/Overlays/Mods/ModColumn.cs
index b615b7bd32..3654f5246d 100644
--- a/osu.Game/Overlays/Mods/ModColumn.cs
+++ b/osu.Game/Overlays/Mods/ModColumn.cs
@@ -33,6 +33,11 @@ namespace osu.Game.Overlays.Mods
     {
         private Func<Mod, bool>? filter;
 
+        /// <summary>
+        /// Function determining whether each mod in the column should be displayed.
+        /// A return value of <see langword="true"/> means that the mod is not filtered and therefore its corresponding panel should be displayed.
+        /// A return value of <see langword="false"/> means that the mod is filtered out and therefore its corresponding panel should be hidden.
+        /// </summary>
         public Func<Mod, bool>? Filter
         {
             get => filter;