From 99068debc41b68636402b866feab04700a01ef82 Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Fri, 29 Jun 2018 13:07:00 +0900
Subject: [PATCH] Split out into separate interface + add xmldocs

---
 osu.Game/Beatmaps/BeatmapProcessor.cs  | 32 +--------------------
 osu.Game/Beatmaps/IBeatmapConverter.cs |  3 ++
 osu.Game/Beatmaps/IBeatmapProcessor.cs | 40 ++++++++++++++++++++++++++
 osu.Game/Rulesets/Ruleset.cs           | 10 +++++++
 4 files changed, 54 insertions(+), 31 deletions(-)
 create mode 100644 osu.Game/Beatmaps/IBeatmapProcessor.cs

diff --git a/osu.Game/Beatmaps/BeatmapProcessor.cs b/osu.Game/Beatmaps/BeatmapProcessor.cs
index 1fc22197fe..0173125e8b 100644
--- a/osu.Game/Beatmaps/BeatmapProcessor.cs
+++ b/osu.Game/Beatmaps/BeatmapProcessor.cs
@@ -6,39 +6,9 @@ using osu.Game.Rulesets.Objects.Types;
 
 namespace osu.Game.Beatmaps
 {
-    public interface IBeatmapProcessor
-    {
-        IBeatmap Beatmap { get; }
-
-        /// <summary>
-        /// Processes the converted <see cref="Beatmap"/> prior to <see cref="HitObject.ApplyDefaults"/> being invoked.
-        /// <para>
-        /// Nested <see cref="HitObject"/>s generated during <see cref="HitObject.ApplyDefaults"/> will not be present by this point,
-        /// and no mods will have been applied to the <see cref="HitObject"/>s.
-        /// </para>
-        /// </summary>
-        /// <remarks>
-        /// This can only be used to add alterations to <see cref="HitObject"/>s generated directly through the conversion process.
-        /// </remarks>
-        void PreProcess();
-
-        /// <summary>
-        /// Processes the converted <see cref="Beatmap"/> after <see cref="HitObject.ApplyDefaults"/> has been invoked.
-        /// <para>
-        /// Nested <see cref="HitObject"/>s generated during <see cref="HitObject.ApplyDefaults"/> will be present by this point,
-        /// and mods will have been applied to all <see cref="HitObject"/>s.
-        /// </para>
-        /// </summary>
-        /// <remarks>
-        /// This should be used to add alterations to <see cref="HitObject"/>s while they are in their most playable state.
-        /// </remarks>
-        void PostProcess();
-    }
-
     /// <summary>
-    /// Processes a post-converted Beatmap.
+    /// Provides functionality to alter a <see cref="IBeatmap"/> after it has been converted.
     /// </summary>
-    /// <typeparam name="TObject">The type of HitObject contained in the Beatmap.</typeparam>
     public class BeatmapProcessor : IBeatmapProcessor
     {
         public IBeatmap Beatmap { get; }
diff --git a/osu.Game/Beatmaps/IBeatmapConverter.cs b/osu.Game/Beatmaps/IBeatmapConverter.cs
index 00566093b8..cbf9d184ac 100644
--- a/osu.Game/Beatmaps/IBeatmapConverter.cs
+++ b/osu.Game/Beatmaps/IBeatmapConverter.cs
@@ -7,6 +7,9 @@ using osu.Game.Rulesets.Objects;
 
 namespace osu.Game.Beatmaps
 {
+    /// <summary>
+    /// Provides functionality to convert a <see cref="IBeatmap"/> for a <see cref="Ruleset"/>.
+    /// </summary>
     public interface IBeatmapConverter
     {
         /// <summary>
diff --git a/osu.Game/Beatmaps/IBeatmapProcessor.cs b/osu.Game/Beatmaps/IBeatmapProcessor.cs
new file mode 100644
index 0000000000..282662373a
--- /dev/null
+++ b/osu.Game/Beatmaps/IBeatmapProcessor.cs
@@ -0,0 +1,40 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+namespace osu.Game.Beatmaps
+{
+    /// <summary>
+    /// Provides functionality to alter a <see cref="IBeatmap"/> after it has been converted.
+    /// </summary>
+    public interface IBeatmapProcessor
+    {
+        /// <summary>
+        /// The <see cref="IBeatmap"/> to process. This should already be converted to the applicable <see cref="Ruleset"/>.
+        /// </summary>
+        IBeatmap Beatmap { get; }
+
+        /// <summary>
+        /// Processes the converted <see cref="Beatmap"/> prior to <see cref="HitObject.ApplyDefaults"/> being invoked.
+        /// <para>
+        /// Nested <see cref="HitObject"/>s generated during <see cref="HitObject.ApplyDefaults"/> will not be present by this point,
+        /// and no mods will have been applied to the <see cref="HitObject"/>s.
+        /// </para>
+        /// </summary>
+        /// <remarks>
+        /// This can only be used to add alterations to <see cref="HitObject"/>s generated directly through the conversion process.
+        /// </remarks>
+        void PreProcess();
+
+        /// <summary>
+        /// Processes the converted <see cref="Beatmap"/> after <see cref="HitObject.ApplyDefaults"/> has been invoked.
+        /// <para>
+        /// Nested <see cref="HitObject"/>s generated during <see cref="HitObject.ApplyDefaults"/> will be present by this point,
+        /// and mods will have been applied to all <see cref="HitObject"/>s.
+        /// </para>
+        /// </summary>
+        /// <remarks>
+        /// This should be used to add alterations to <see cref="HitObject"/>s while they are in their most playable state.
+        /// </remarks>
+        void PostProcess();
+    }
+}
diff --git a/osu.Game/Rulesets/Ruleset.cs b/osu.Game/Rulesets/Ruleset.cs
index f818523a3d..82d9945ef7 100644
--- a/osu.Game/Rulesets/Ruleset.cs
+++ b/osu.Game/Rulesets/Ruleset.cs
@@ -57,8 +57,18 @@ namespace osu.Game.Rulesets
         /// <returns></returns>
         public abstract RulesetContainer CreateRulesetContainerWith(WorkingBeatmap beatmap);
 
+        /// <summary>
+        /// Creates a <see cref="IBeatmapConverter"/> to convert a <see cref="IBeatmap"/> to one that is applicable for this <see cref="Ruleset"/>.
+        /// </summary>
+        /// <param name="beatmap">The <see cref="IBeatmap"/> to be converted.</param>
+        /// <returns>The <see cref="IBeatmapConverter"/>.</returns>
         public abstract IBeatmapConverter CreateBeatmapConverter(IBeatmap beatmap);
 
+        /// <summary>
+        /// Optionally creates a <see cref="IBeatmapProcessor"/> to alter a <see cref="IBeatmap"/> after it has been converted.
+        /// </summary>
+        /// <param name="beatmap">The <see cref="IBeatmap"/> to be processed.</param>
+        /// <returns>The <see cref="IBeatmapProcessor"/>.</returns>
         public virtual IBeatmapProcessor CreateBeatmapProcessor(IBeatmap beatmap) => null;
 
         public abstract DifficultyCalculator CreateDifficultyCalculator(WorkingBeatmap beatmap);