Update docs/fsharp/language-reference/xml-documentation.md

shethaadit · psfinaki · web-flow · commit 1d80810771d2 · 2024-12-13T10:30:27.000-08:00
Resolving comments.

Co-authored-by: Petr &lt;psfinaki@users.noreply.github.com&gt;
diff --git a/docs/fsharp/language-reference/xml-documentation.md b/docs/fsharp/language-reference/xml-documentation.md
@@ -14,7 +14,7 @@ The compiler-generated XML file can be distributed alongside your .NET assembly
 show quick information about types or members. Additionally, the XML file can be run through tools
 like [fsdocs](http://fsprojects.github.io/FSharp.Formatting/) to generate API reference websites.
 
-XML documentation comments are not ignored by the compiler; they are processed to generate XML documentation files if the appropriate settings are enabled. Additionally, the compiler can check the validity and completeness of these comments at compile time when specific options are configured.
+By default, XML documentation comments are ignored by the compiler. To change this, set `--warnon:3390`. The compiler will then verify the syntax of the XML and the parameters referred to in <param> and <paramref> tags.
 
 You can generate the XML file at compile time by doing one of the following:
 
