Add render options

Author: a-gubskiy

src/Render/BitzArt.XDoc.PlainText/PlainTextRenderer.cs

@@ -13,33 +13,45 @@ public class PlainTextRenderer
     /// Converts an XML documentation node to the plain text.
     /// </summary>
     /// <param name="documentation"></param>
+    /// <param name="forceSingleLine"></param>
+    /// <param name="useShortTypeNames"></param>
     /// <returns></returns>
-    public static string Render(MemberDocumentation? documentation)
+    public static string Render(
+        MemberDocumentation? documentation,
+        bool forceSingleLine = false,
+        bool useShortTypeNames = true)
     {
         if (documentation == null)
         {
             return string.Empty;
         }
 
-        return new PlainTextRenderer(documentation).Render();
+        return new PlainTextRenderer(documentation, new RendererOptions
+        {
+            ForceSingleLine = forceSingleLine,
+            UseShortTypeNames = useShortTypeNames
+        }).Render();
     }
 
     /// <summary>
     /// The documentation instance to be rendered by this renderer.
     /// This field is initialized in the constructor and remains readonly afterward.
     /// </summary>
-    protected readonly MemberDocumentation Documentation;
+    private readonly MemberDocumentation _documentation;
+
+    private readonly RendererOptions _options;
 
-    protected PlainTextRenderer(MemberDocumentation documentation)
+    private PlainTextRenderer(MemberDocumentation documentation, RendererOptions rendererOptions)
     {
-        Documentation = documentation;
+        _options = rendererOptions;
+        _documentation = documentation;
     }
 
     /// <summary>
     /// Renders the current documentation to plain text.
     /// </summary>
     /// <returns>A normalized plain text representation of the documentation.</returns>
-    protected string Render() => Normalize(Render(Documentation.Node));
+    private string Render() => Normalize(Render(_documentation.Node));
 
     /// <summary>
     /// Renders the content of an XML node to plain text.
@@ -70,9 +82,9 @@ private string Normalize(string input)
             .Where(o => !string.IsNullOrWhiteSpace(o))
             .ToList();
 
-        var result = string.Join("\n", lines);
+        var separator = _options.ForceSingleLine ? " " : "\n";
 
-        return result;
+        return string.Join(separator, lines);
     }
 
     /// <summary>
@@ -102,9 +114,9 @@ private string RenderXmlElement(XmlElement element)
     /// </summary>
     /// <param name="element"></param>
     /// <returns></returns>
-    protected virtual string RenderReference(XmlElement element)
+    private string RenderReference(XmlElement element)
     {
-        var documentationReference = Documentation.GetReference(element);
+        var documentationReference = _documentation.GetReference(element);
 
         if (documentationReference == null)
         {
@@ -134,18 +146,28 @@ private string RenderSimpleDocumentationReference(DocumentationReference documen
 
         if (cref.Prefix is "T:")
         {
-            return cref.ShortType;
+            if (_options.UseShortTypeNames)
+            {
+                return cref.ShortType;
+            }
+
+            return cref.Type;
         }
 
         if (cref.Prefix is "M:" or "P:" or "F:")
         {
-            return $"{cref.ShortType}.{cref.Member}";
+            if (_options.UseShortTypeNames)
+            {
+                return $"{cref.ShortType}.{cref.Member}";
+            }
+
+            return $"{cref.Type}.{cref.Member}";
         }
 
         return string.Empty;
     }
 
-    private static string RenderDocumentationReference(DocumentationReference documentationReference)
+    private string RenderDocumentationReference(DocumentationReference documentationReference)
     {
         if (documentationReference.Target == null)
         {
@@ -167,10 +189,6 @@ private static string RenderDocumentationReference(DocumentationReference docume
         };
 
         return text;
-
-        // var renderer = new PlainTextRenderer(documentationReference.Target);
-        //
-        // return renderer.Render();
     }
 
     /// <summary>

src/Render/BitzArt.XDoc.PlainText/RendererOptions.cs

@@ -0,0 +1,21 @@
+namespace BitzArt.XDoc;
+
+/// <summary>
+/// Configuration options for controlling XML documentation rendering behavior.
+/// </summary>
+public record RendererOptions
+{
+    /// <summary>
+    /// Indicating whether the content should be forced to render as a single line.
+    /// When set to true, any line breaks in the content will be removed or replaced.
+    /// When set to false, the content will maintain its original line structure.
+    /// </summary>
+    public bool ForceSingleLine { get; init; } = true;
+
+    /// <summary>
+    /// Indicating whether type names should be rendered in their short form.
+    /// When set to true, simple type names will be used (e.g., "string" instead of "System.String").
+    /// When set to false, fully qualified type names will be used.
+    /// </summary>
+    public bool UseShortTypeNames { get; init; } = true;
+}

src/Render/BitzArt.XDoc.PlainText/XDocExtensions.cs

@@ -9,14 +9,15 @@ public static class XDocExtensions
     /// Renders the documentation of a <see cref="Type"/> as plain text.
     /// </summary>
     /// <param name="documentation"></param>
+    /// <param name="forceSingleLine"></param>
     /// <returns></returns>
-    public static string ToPlainText(this MemberDocumentation? documentation)
+    public static string ToPlainText(this MemberDocumentation? documentation, bool forceSingleLine = false)
     {
         if (documentation == null)
         {
             return string.Empty;
         }
 
-        return PlainTextRenderer.Render(documentation);
+        return PlainTextRenderer.Render(documentation, forceSingleLine);
     }
 }