Cleanup C# doc comment generation

cpp/src/Slice/Parser.cpp

@@ -614,7 +614,8 @@ namespace
         }
     }
 
-    StringList splitComment(string comment, function<string(string, string)> linkFormatter, bool stripMarkup)
+    StringList
+    splitComment(string comment, function<string(string, string)> linkFormatter, bool stripMarkup, bool xmlEscape)
     {
         string::size_type pos = 0;
 
@@ -634,6 +635,37 @@ namespace
                     comment.erase(pos, endpos - pos + 1);
                 }
             } while (pos != string::npos);
+
+            // Escape XML entities.
+            if (xmlEscape)
+            {
+                const string amp = "&amp;";
+                const string lt = "&lt;";
+                const string gt = "&gt;";
+
+                pos = 0;
+                while ((pos = comment.find_first_of("&<>", pos)) != string::npos)
+                {
+                    switch (comment[pos])
+                    {
+                        case '&':
+                            comment.replace(pos, 1, amp);
+                            pos += amp.size();
+                            break;
+                        case '<':
+                            comment.replace(pos, 1, lt);
+                            pos += lt.size();
+                            break;
+                        case '>':
+                            comment.replace(pos, 1, gt);
+                            pos += gt.size();
+                            break;
+                        default:
+                            assert(false);
+                            break;
+                    }
+                }
+            }
         }
 
         // Fix any link tags using the provided link formatter.
@@ -729,14 +761,15 @@ namespace
 }
 
 DocCommentPtr
-Slice::Contained::parseDocComment(function<string(string, string)> linkFormatter, bool stripMarkup) const
+Slice::Contained::parseDocComment(function<string(string, string)> linkFormatter, bool stripMarkup, bool xmlEscape)
+    const
 {
     // Some tags are only valid if they're applied to an operation.
     // If they aren't, we want to ignore the tag and issue a warning.
     bool isOperation = dynamic_cast<const Operation*>(this);
 
     // Split the comment's raw text up into lines.
-    StringList lines = splitComment(_docComment, std::move(linkFormatter), stripMarkup);
+    StringList lines = splitComment(_docComment, std::move(linkFormatter), stripMarkup, xmlEscape);
     if (lines.empty())
     {
         return nullptr;

cpp/src/Slice/Parser.h

@@ -371,9 +371,18 @@ namespace Slice
         [[nodiscard]] int line() const;
 
         [[nodiscard]] std::string docComment() const;
+
+        /// Parses the documentation comment into a structured format.
+        ///
+        /// @param linkFormatter A function used to format links according to the expected documentation format.
+        /// @param stripMarkup If true, removes all HTML markup from the parsed comment. Defaults to false.
+        /// @param xmlEscape  If true, escapes all XML special characters in the parsed comment. Defaults to false.
+        /// @return The parsed documentation comment or nullptr if the element does not contain a documentation
+        /// comment.
         [[nodiscard]] DocCommentPtr parseDocComment(
             std::function<std::string(std::string, std::string)> linkFormatter,
-            bool stripMarkup = false) const;
+            bool stripMarkup = false,
+            bool xmlEscape = false) const;
 
         [[nodiscard]] int includeLevel() const;
 

cpp/src/slice2cs/CsUtil.h

@@ -38,6 +38,8 @@ namespace Slice
             const std::string& prefix = "",
             const std::string& suffix = "");
 
+        static std::string fixId(const std::string&, unsigned int = 0, bool = false);
+
     protected:
         //
         // Returns the namespace prefix of a Contained entity.
@@ -47,7 +49,6 @@ namespace Slice
         static std::string resultStructName(const std::string&, const std::string&, bool = false);
         static std::string resultType(const OperationPtr&, const std::string&, bool = false);
         static std::string taskResultType(const OperationPtr&, const std::string&, bool = false);
-        static std::string fixId(const std::string&, unsigned int = 0, bool = false);
         static std::string getOptionalFormat(const TypePtr&);
         static std::string getStaticId(const TypePtr&);
         static std::string typeToString(const TypePtr&, const std::string&, bool = false);