Skip to content

Commit 2a12802

Browse files
authored
Enclose property descriptions with CDATA (confluentinc#2453)
avoids warnings because of XML reserved characters. Solves the lack of those fields in docfx generated documentation
1 parent 4dc7b98 commit 2a12802

File tree

2 files changed

+557
-315
lines changed

2 files changed

+557
-315
lines changed

src/ConfigGen/Program.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,10 +346,12 @@ static string createProperties(IEnumerable<PropertySpecification> props)
346346
var nullableType = type == "string" ? "string" : type + "?";
347347

348348
codeText += $" /// <summary>\n";
349+
codeText += $" /// <![CDATA[\n";
349350
codeText += $" /// {prop.Description}\n";
350351
codeText += $" ///\n";
351352
codeText += $" /// default: {(prop.Default == "" ? "''" : prop.Default)}\n";
352353
codeText += $" /// importance: {prop.Importance}\n";
354+
codeText += $" /// ]]>\n";
353355
codeText += $" /// </summary>\n";
354356
codeText += $" public {nullableType} {ConfigNameToDotnetName(prop.Name)} {{ get {{ return ";
355357
switch (type)

0 commit comments

Comments
 (0)