This causes a build error, rather than the default behavior of a warning, for the following conditions:
An XML comment is malformed, like it's not valid XML at all (1570)
A <param> tag was omitted, duplicated, or had an unknown name (1571, 1572, 1573)
A cref link specified an unknown symbol or had a syntax error (1574, 1580, 1584)
A <returns> tag specified an unknown type (1581)
A public type, method, or property doesn't have an XML comment (1591)
A <typeparam> tag was omitted, duplicated, or had an unknown name (1710, 1711, 1712)
Unfortunately, there are several kinds of mistakes it can't detect:
If you misspell a tag, as long as the closing tag is identically misspelled (like <summar>...</summar> instead of <summary>), it assumes that that's just HTML and lets it be.
If you omit all the <param> or <typeparam> tags for a method, it's OK with that. It only complains if you provide tags for some of the parameters but not all.
I may have missed some error codes since there doesn't seem to be a single list showing all of the XML-comment-related ones.
This causes a build error, rather than the default behavior of a warning, for the following conditions:
<param>tag was omitted, duplicated, or had an unknown name (1571, 1572, 1573)creflink specified an unknown symbol or had a syntax error (1574, 1580, 1584)<returns>tag specified an unknown type (1581)<typeparam>tag was omitted, duplicated, or had an unknown name (1710, 1711, 1712)Unfortunately, there are several kinds of mistakes it can't detect:
<summar>...</summar>instead of<summary>), it assumes that that's just HTML and lets it be.<param>or<typeparam>tags for a method, it's OK with that. It only complains if you provide tags for some of the parameters but not all.I may have missed some error codes since there doesn't seem to be a single list showing all of the XML-comment-related ones.