Skip to content
This repository has been archived by the owner on Dec 23, 2024. It is now read-only.

Commit

Permalink
Check XML doc parameter names for FSharp.Core via opt-in checking (do…
Browse files Browse the repository at this point in the history
…tnet#10118)

* optionally check xml doc comments for xml validity

* check xml docs

* check xml docs

* xml checks 2

* fix baselines

* check parameter names

* fix baseline

* check parameters names

* allow delegate param doc

* fix FSHarp.Core doc problems

* fix docs

* fix docs

* fix diagnostics

* fix diagnostics

* update baselines

* provide elaborated xml docs in FCS API

* fix test

* use 38 ver

* fix build

* check docs of FCS

* start to fix FCS docs

* complete some FCS docs and enable doc checking

* fix duplicate checking

* fix duplicate checking

* update baselines and xlf

* correct xml text for legacy test

Co-authored-by: Don Syme <[email protected]>
  • Loading branch information
2 people authored and nosami committed Feb 22, 2021
1 parent 2e37cfd commit df72efe
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions DocComments/XMLDocumentation.fs
Original file line number Diff line number Diff line change
Expand Up @@ -371,8 +371,8 @@ module internal XmlDocumentation =
| FSharpXmlDoc.None -> ()
| FSharpXmlDoc.XmlDocFileSignature(filename,signature) ->
documentationProvider.AppendDocumentation(xmlCollector, exnCollector, filename, signature, showExceptions, showParameters, paramName)
| FSharpXmlDoc.Text(rawXml) ->
let processedXml = ProcessXml(rawXml)
| FSharpXmlDoc.Text(_rawText, processedXml) ->
let processedXml = ProcessXml("\n\n" + String.concat "\n" processedXml)
documentationProvider.AppendDocumentationFromProcessedXML(xmlCollector, exnCollector, processedXml, showExceptions, showParameters, paramName)

let private AddSeparator (collector: ITaggedTextCollector) =
Expand Down

0 comments on commit df72efe

Please sign in to comment.