Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-3854

C# avrogen copies "doc" property to XML doc comment even if it is not valid XML

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • 1.11.1
    • None
    • csharp, tools
    • None

    Description

      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.

      Attachments

        Activity

          People

            Unassigned Unassigned
            kniemitalo Kalle Niemitalo
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: