Skip to content

Commit e9bd874

Browse files
authored
Merge pull request #43960 from shethaadit/shethaadit/FixBug41853
Clarify XML Documentation Comments Processing in F#.
2 parents 8995edc + 20159be commit e9bd874

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ The compiler-generated XML file can be distributed alongside your .NET assembly
1414
show quick information about types or members. Additionally, the XML file can be run through tools
1515
like [fsdocs](http://fsprojects.github.io/FSharp.Formatting/) to generate API reference websites.
1616

17-
XML documentation comments, like all other comments, are ignored by the compiler, unless the options described below are enabled to check the validity and
18-
completeness of comments at compile time.
17+
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.
1918

2019
You can generate the XML file at compile time by doing one of the following:
2120

0 commit comments

Comments
 (0)