Kalle Niemitalo created AVRO-3854:
-------------------------------------

             Summary: C# avrogen copies "doc" property to XML doc comment even 
if it is not valid XML
                 Key: AVRO-3854
                 URL: https://issues.apache.org/jira/browse/AVRO-3854
             Project: Apache Avro
          Issue Type: Bug
          Components: csharp, tools
    Affects Versions: 1.11.1
            Reporter: Kalle Niemitalo


The C# "avrogen" tool copies the values of "doc" properties from the schema to 
XML documentation comments in the generated C# files.  If the "doc" property 
contains XML reserved characters but is not valid XML, then they will cause 
warnings when the generated C# file is later compiled.  This can happen if the 
"doc" property is e.g. Markdown intended to be processed by a different tool.

The "avrogen" tool should either encode the XML reserved characters or provide 
a way to omit the XML documentation comments entirely.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to