Make BuiltInMarkupReplacer public; add docs for ProcessReplacementMarker

Author: desplesda

YarnSpinner/YarnSpinner.Markup/IAttributeMarkerProcessor.cs

@@ -30,8 +30,39 @@ namespace Yarn.Markup
     /// <summary>Provides a mechanism for producing replacement text for a
     /// marker.</summary>
     /// <seealso cref="LineParser.RegisterMarkerProcessor"/>
+    /// <seealso cref="LineParser.DeregisterMarkerProcessor(string)"/>
     public interface IAttributeMarkerProcessor
     {
+        /// <summary>
+        /// Produces replacement text for a marker.
+        /// </summary>
+        /// <param name="marker">The marker to process into replacement
+        /// text.</param>
+        /// <param name="childBuilder">A <see cref="System.Text.StringBuilder"/>
+        /// that contains the child text contained within <paramref
+        /// name="marker"/>. Use the methods on this stringbuilder to produce
+        /// any text needed from this marker.</param>
+        /// <param name="childAttributes">The child attributes of <paramref
+        /// name="marker"/>.</param>
+        /// <param name="localeCode">A BCP-47 locale code that represents the
+        /// locale in which any processing should take place.</param>
+        /// <example>
+        /// <para>If the original text being processed by <see
+        /// cref="LineParser.ParseString(string, string, bool)"/> is "<c>[a]
+        /// text1 [b/] text2 [/a]</c>", then the following facts will be
+        /// true:</para>
+        /// <list type="bullet">
+        /// <item>
+        /// <paramref name="childBuilder"/> will contain the text "text1 text2".
+        /// </item>
+        /// <item>
+        /// <paramref name="childAttributes"/> will contain a MarkupAttribute
+        /// named "<c>b</c>".
+        /// </item>
+        /// </list>
+        /// </example>
+        /// <returns>The collection of diagnostics produced during processing,
+        /// if any.</returns>
         public List<LineParser.MarkupDiagnostic> ProcessReplacementMarker(MarkupAttribute marker, System.Text.StringBuilder childBuilder, List<MarkupAttribute> childAttributes, string localeCode);
     }
 }

YarnSpinner/YarnSpinner.Markup/LineParser.cs

@@ -1598,7 +1598,11 @@ public void Dispose()
         }
     }
 
-    internal class BuiltInMarkupReplacer : IAttributeMarkerProcessor
+    /// <summary>
+    /// A marker processor that handles the built-in markers <c>[select]</c>
+    /// <c>[plural]</c>, and <c>[ordinal]</c>.
+    /// </summary>
+    public class BuiltInMarkupReplacer : IAttributeMarkerProcessor
     {
         private static readonly System.Text.RegularExpressions.Regex ValuePlaceholderRegex = new System.Text.RegularExpressions.Regex(@"(?<!\\)%");
 
@@ -1689,6 +1693,7 @@ internal class BuiltInMarkupReplacer : IAttributeMarkerProcessor
             return diagnostics;
         }
 
+        /// <inheritdoc/>
         public List<LineParser.MarkupDiagnostic> ProcessReplacementMarker(MarkupAttribute marker, StringBuilder childBuilder, List<MarkupAttribute> childAttributes, string localeCode)
         {
             // we have somehow been given an invalid setup, can't continue so early out.