fable-compiler/ts2fable

Invalid XML Comments because of unescaped characters

Booksbaum opened this issue · 0 comments

Generated XML Comments quite often contain unescaped xml characters, that produce a compiler warning (with newer F# compiler versions), like

Warning FS3390 This XML comment is invalid: 'An error occurred while parsing EntityName.

Characters to escape:
&, < (somehow >, ', " are ok...but should probably be escaped too)

Note: required even inside code tags (<c>...</c>)

Note: required even inside attribute: (C# docs)

To refer to generic identifiers in code reference (cref) elements, you can use either the escape characters (for example, cref="List<T>") or braces (cref="List{T}")