Add BoldElement

Author: caesay

src/MdDocs.ApiReference/Model/XmlDocs/IVisitor.cs

@@ -16,6 +16,8 @@ public interface IVisitor
 
         void Visit(TextElement element);
 
+        void Visit(BoldElement element);
+
         void Visit(SeeElement element);
 
         void Visit(TextBlock textBlock);

src/MdDocs.ApiReference/Model/XmlDocs/XmlDocsReader.cs

@@ -206,7 +206,7 @@ internal void ReadMemberContent(XElement xml, MemberElement member)
 
                     // ignore unknown elements
                     default:
-                        m_Logger.LogWarning($"Encountered unknown element '{elementName}'. Element will be ignored.");
+                        m_Logger.LogWarning($"Encountered unknown element in member '{elementName}'. Element will be ignored.");
                         break;
                 }
             }
@@ -281,6 +281,20 @@ internal TextBlock ReadTextBlock(XElement xml)
                                 element = new CElement(elementNode.Value);
                                 break;
 
+                            case "b":
+                                element = new BoldElement(ReadTextBlock(elementNode));
+                                break;
+
+                            case "a":
+                                if (elementNode.TryGetAttributeValue("href", out var linkHref))
+                                {
+                                    if (Uri.TryCreate(linkHref, UriKind.Absolute, out var target))
+                                    {
+                                        element = new SeeElement(target, ReadTextBlock(elementNode));
+                                    }
+                                }
+                                break;
+
                             case "see":
                                 // <see /> allows adding links to the documentation
                                 //
@@ -313,7 +327,7 @@ internal TextBlock ReadTextBlock(XElement xml)
 
                             // ignore unknown elements
                             default:
-                                m_Logger.LogWarning($"Encountered unknown element '{elementNode.Name}'. Element will be ignored.");
+                                m_Logger.LogWarning($"Encountered unknown element in text block '{elementNode.Name}'. Element will be ignored.");
                                 break;
                         }
                         break;
@@ -451,8 +465,8 @@ private static string TrimLines(string content, StringSplitOptions splitOptions,
             if (lines.Count == 0)
                 return String.Empty;
 
-            // Indent in generated XML doc files is greater than 4 always. 
-            // This allows us to optimize the case where the author actually placed 
+            // Indent in generated XML doc files is greater than 4 always.
+            // This allows us to optimize the case where the author actually placed
             // whitespace inline in between tags.
             if (indent <= 4 && !String.IsNullOrEmpty(lines[0]) && lines[0][0] != '\t')
                 indent = 0;
@@ -477,13 +491,13 @@ private static string TrimLines(string content, StringSplitOptions splitOptions,
         /// </summary>
         private static int? DetermineIndentation(string content)
         {
-            //  When inline documentation is written to a XML file by the compiler, 
+            //  When inline documentation is written to a XML file by the compiler,
             //  all text is indented by the same number of character:
             //
             //  Entire block is indented
             //    │
-            //    │    <member name="F:DemoProject.DemoClass.Field1">             Empty leading line  
-            //    │       <remarks>                                         <───────┘                        
+            //    │    <member name="F:DemoProject.DemoClass.Field1">             Empty leading line
+            //    │       <remarks>                                         <───────┘
             //    └───>     Remarks allow specification of more detailed information about a member, in this case a field
             //              supplementing the information specified in the summary
             //  ┌───>     </remarks>
@@ -493,10 +507,10 @@ private static string TrimLines(string content, StringSplitOptions splitOptions,
             //  Empty trailing line
             //
             //  In order to properly render the documentation, the leading whitespace
-            //  needs to be removed. 
-            //  
+            //  needs to be removed.
+            //
             //  This methods determines the number of character that have to be removed
-            //  from all lines by 
+            //  from all lines by
             //    - removing the first line (probably only whitespace, as can be seen in the example above)
             //    - removing the last line (probably only whitespace, as can be seen in the example above)
             //    - counting the number of whitespace characters in the first non-whitespace line
@@ -521,9 +535,9 @@ private static string TrimLines(string content, StringSplitOptions splitOptions,
             if (lines.Count == 0)
                 return null;
 
-            // The indent of the first line of content determines the base 
-            // indent for all the lines, which we should remove since it's just 
-            // a doc gen artifact.            
+            // The indent of the first line of content determines the base
+            // indent for all the lines, which we should remove since it's just
+            // a doc gen artifact.
             return lines[0].TakeWhile(c => Char.IsWhiteSpace(c)).Count();
 
         }

src/MdDocs.ApiReference/Model/XmlDocs/_TextElements/BoldElement.cs

@@ -0,0 +1,41 @@
+using System;
+
+namespace Grynwald.MdDocs.ApiReference.Model.XmlDocs
+{
+    /// <summary>
+    /// Represents a bold text element in XML documentation comments.
+    /// </summary>
+    /// <remarks>
+    /// For a list of tags in documentation comments, see
+    /// https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments
+    /// </remarks>
+    public class BoldElement : Element, IEquatable<BoldElement>
+    {
+        /// <summary>
+        /// Gets the bold text elements content
+        /// </summary>
+        public TextBlock Content { get; }
+
+        /// <summary>
+        /// Initializes a new instance of <see cref="BoldElement"/>.
+        /// </summary>
+        /// <param name="content">The text element's content.</param>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="content"/> is <c>null</c>.</exception>
+        public BoldElement(TextBlock content)
+        {
+            Content = content ?? throw new ArgumentNullException(nameof(content));
+        }
+
+        /// <inheritdoc />
+        public override void Accept(IVisitor visitor) => visitor.Visit(this);
+
+        /// <inheritdoc />
+        public override int GetHashCode() => StringComparer.Ordinal.GetHashCode(Content);
+
+        /// <inheritdoc />
+        public override bool Equals(object? obj) => Equals(obj as BoldElement);
+
+        /// <inheritdoc />
+        public bool Equals(BoldElement? other) => other != null && StringComparer.Ordinal.Equals(Content, other.Content);
+    }
+}

src/MdDocs.ApiReference/Model/XmlDocs/_TextElements/TextElement.cs

@@ -3,7 +3,7 @@
 namespace Grynwald.MdDocs.ApiReference.Model.XmlDocs
 {
     /// <summary>
-    /// Represents a plaint text element in XML documentation comments.
+    /// Represents a plain text element in XML documentation comments.
     /// </summary>
     /// <remarks>
     /// For a list of tags in documentation comments, see

src/MdDocs.ApiReference/Templates/Default/_Helpers/ConvertToBlockVisitor.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection.Metadata.Ecma335;
 using Grynwald.MarkdownGenerator;
 using Grynwald.MdDocs.ApiReference.Model.XmlDocs;
 
@@ -22,7 +23,7 @@ internal class ConvertToBlockVisitor : IVisitor
         public MdContainerBlock Result { get; }
 
         /// <summary>
-        /// Gets the markdown block currently being appended to 
+        /// Gets the markdown block currently being appended to
         /// </summary>
         private MdContainerBlockBase CurrentBlock => m_Blocks.Peek();
 
@@ -59,6 +60,15 @@ public void Visit(CodeElement element)
 
         public void Visit(TextElement element) => AddToCurrentParagraph(new MdTextSpan(element.Content));
 
+        public void Visit(BoldElement element)
+        {
+            if (!element.Content.IsEmpty)
+            {
+                var text = TextBlockToMarkdownConverter.ConvertToSpan(element.Content, m_SpanFactory);
+                AddToCurrentParagraph(new MdStrongEmphasisSpan(text));
+            }
+        }
+
         public void Visit(SeeElement element)
         {
             if (element is null)

src/MdDocs.ApiReference/Templates/Default/_Helpers/ConvertToSpanVisitor.cs

@@ -39,6 +39,15 @@ public void Visit(CodeElement element)
 
         public void Visit(TextElement element) => Result.Add(new MdTextSpan(element.Content));
 
+        public void Visit(BoldElement element)
+        {
+            if (!element.Content.IsEmpty)
+            {
+                var text = TextBlockToMarkdownConverter.ConvertToSpan(element.Content, m_SpanFactory);
+                Result.Add(new MdStrongEmphasisSpan(text));
+            }
+        }
+
         public void Visit(SeeElement element)
         {
             MdSpan span;