From 2508bd77ae2dbaad5e6ee9c898ac2ff4e88cbe6c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 8 Oct 2025 19:13:22 +0000 Subject: [PATCH 1/3] Initial plan From 7520875ca9120533f4379831835857e7e445b3a4 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 8 Oct 2025 19:16:55 +0000 Subject: [PATCH 2/3] Fix missing 'approach' word and add WarnOn project file example Co-authored-by: BillWagner <493969+BillWagner@users.noreply.github.com> --- docs/fsharp/language-reference/xml-documentation.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/fsharp/language-reference/xml-documentation.md b/docs/fsharp/language-reference/xml-documentation.md index f9a0587581435..b67c16e827788 100644 --- a/docs/fsharp/language-reference/xml-documentation.md +++ b/docs/fsharp/language-reference/xml-documentation.md @@ -16,6 +16,12 @@ like [fsdocs](http://fsprojects.github.io/FSharp.Formatting/) to generate API re 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 `` and `` tags. +You can enable this warning in your project file by adding a `` element to the `` section: + +```xml +3390 +``` + You can generate the XML file at compile time by doing one of the following: - You can add a `GenerateDocumentationFile` element to the `` section of your `.fsproj` project file, @@ -49,7 +55,7 @@ The following example shows the alternative method, without XML tags. In this ex ## Comments with XML tags If a comment body begins with `<` (normally ``), then it is treated as an XML formatted comment -body using XML tags. This second way enables you to specify separate notes +body using XML tags. This second approach enables you to specify separate notes for a short summary, additional remarks, documentation for each parameter and type parameter and exceptions thrown, and a description of the return value. The following is a typical XML documentation comment in a signature file: From 680d291ea76a465fc371b391041c26730f5b2387 Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Thu, 9 Oct 2025 09:37:56 -0400 Subject: [PATCH 3/3] Update docs/fsharp/language-reference/xml-documentation.md --- docs/fsharp/language-reference/xml-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/fsharp/language-reference/xml-documentation.md b/docs/fsharp/language-reference/xml-documentation.md index b67c16e827788..1dbf384215a13 100644 --- a/docs/fsharp/language-reference/xml-documentation.md +++ b/docs/fsharp/language-reference/xml-documentation.md @@ -16,7 +16,7 @@ like [fsdocs](http://fsprojects.github.io/FSharp.Formatting/) to generate API re 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 `` and `` tags. -You can enable this warning in your project file by adding a `` element to the `` section: +You can enable this warning in your project file by adding a `` element to a `` section: ```xml 3390