improve handling of nested xml

Author: dawedawe

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.1.1] - 2023-12-25
+
+### Fixed
+
+* Improve handling of nested xml.
+
 ## [0.1.0] - 2023-12-24
 
 ### Added

src/Fsih.Tests/Tests.fs

@@ -85,3 +85,37 @@ let ``full info is as expected for Seq.splitInto`` () =
 
     | Some _ -> Assert.False(true, sprintf "unexpected help")
     | None -> Assert.False(true, sprintf "no docs for Seq.splitInto")
+
+[<Fact>]
+let ``returns is as expected for HashIdentity.FromFunctions`` () =
+    let doc = tryGetDocumentation <@ HashIdentity.FromFunctions @>
+
+    match doc with
+    | Some { Returns = Some returns } ->
+        Assert.Equal(
+            "An object implementing System.Collections.Generic.IEqualityComparer using the given functions.",
+            returns
+        )
+    | Some _ -> Assert.False(true, sprintf "unexpected help")
+    | None -> Assert.False(true, sprintf "no docs for Seq.splitInto")
+
+[<Fact>]
+let ``remarks is as expected for List.reduce`` () =
+    let doc = tryGetDocumentation <@ List.reduce @>
+
+    match doc with
+    | Some { Remarks = Some remarks } -> Assert.Equal("Raises System.ArgumentException if list is empty", remarks)
+    | Some _ -> Assert.False(true, sprintf "unexpected help")
+    | None -> Assert.False(true, sprintf "no docs for Seq.splitInto")
+
+[<Fact>]
+let ``summary is as expected for Array.sortDescending`` () =
+    let doc = tryGetDocumentation <@ Array.sortDescending @>
+
+    match doc with
+    | Some { Summary = summary } ->
+        Assert.Equal(
+            "Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Microsoft.FSharp.Core.Operators.compare.",
+            summary
+        )
+    | None -> Assert.False(true, sprintf "no docs for Seq.splitInto")

src/Fsih/Parser.fs

@@ -58,9 +58,19 @@ type Help =
 
 let cleanupXmlContent (s: string) = s.Replace("\n ", "\n").Trim() // some stray whitespace from the XML
 
+// remove any leading `X:` and trailing `N
+let trimDotNet (s: string) =
+    let s = if s.Length > 2 && s[1] = ':' then s.Substring(2) else s
+    let idx = s.IndexOf('`')
+    let s = if idx > 0 then s.Substring(0, idx) else s
+    s
+
 let xmlDocCache = Collections.Generic.Dictionary<string, XmlDocument>()
 
 let getXmlDocument xmlPath =
+#if DEBUG
+    printfn $"xml file: %s{xmlPath}"
+#endif
     match xmlDocCache.TryGetValue(xmlPath) with
     | true, value -> value
     | _ ->
@@ -70,6 +80,22 @@ let getXmlDocument xmlPath =
         xmlDocCache.Add(xmlPath, xmlDocument)
         xmlDocument
 
+let getTexts (node: Xml.XmlNode) =
+    seq {
+        for child in node.ChildNodes do
+            if child.Name = "#text" then
+                yield child.Value
+
+            if child.Name = "c" then
+                yield child.InnerText
+
+            if child.Name = "see" then
+                let cref = child.Attributes.GetNamedItem("cref")
+
+                if not (isNull cref) then
+                    yield cref.Value |> trimDotNet
+    }
+    |> String.concat ""
 
 let helpText (xmlPath: string) (assembly: string) (modName: string) (implName: string) (sourceName: string) =
     let sourceName = sourceName.Replace('.', '#') // for .ctor
@@ -103,13 +129,13 @@ let helpText (xmlPath: string) (assembly: string) (modName: string) (implName: s
         let summary =
             n.SelectSingleNode("summary")
             |> Option.ofObj
-            |> Option.map _.InnerText
+            |> Option.map getTexts
             |> Option.map cleanupXmlContent
 
         let remarks =
             n.SelectSingleNode("remarks")
             |> Option.ofObj
-            |> Option.map _.InnerText
+            |> Option.map getTexts
             |> Option.map cleanupXmlContent
 
         let parameters =
@@ -119,7 +145,9 @@ let helpText (xmlPath: string) (assembly: string) (modName: string) (implName: s
             |> List.ofSeq
 
         let returns =
-            n.SelectSingleNode("returns") |> Option.ofObj |> Option.map _.InnerText.Trim()
+            n.SelectSingleNode("returns")
+            |> Option.ofObj
+            |> Option.map (fun n -> getTexts(n).Trim())
 
         let exceptions =
             n.SelectNodes("exception")

src/Fsih/Program.fs

@@ -92,25 +92,27 @@ module Program =
 
     [<EntryPoint>]
     let main argv =
-        h <@ Option.isNone @>
-        h <@ Option.defaultValue @>
-        h <@ Seq.allPairs @>
-        h <@ Seq.iter @>
-        h <@ Seq.average [ 1. ] @>
-        h <@ Seq.append @>
-        h <@ Seq.average [ 1. ] @>
-        h <@ printfn @>
-        h <@ None @>
-        h <@ System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes @>
-        h <@ Collections.ResizeArray<int> [] @>
-        h <@ [] @>
-        h <@ "" @>
-        h <@ 1 :: List.empty @>
-        h <@ Map @>
-        h <@ [| 1 |] @>
-        h <@ Array.Parallel.tryFind @>
-        h <@ Seq.head @>
-        h <@ Seq.delay @>
-        h <@ Seq.countBy @>
+        // h <@ Option.isNone @>
+        // h <@ Option.defaultValue @>
+        // h <@ Seq.allPairs @>
+        // h <@ Seq.iter @>
+        // h <@ Seq.average [ 1. ] @>
+        // h <@ Seq.append @>
+        // h <@ Seq.average [ 1. ] @>
+        // h <@ printfn @>
+        // h <@ None @>
+        // h <@ System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes @>
+        // h <@ Collections.ResizeArray<int> [] @>
+        // h <@ [] @>
+        // h <@ "" @>
+        // h <@ 1 :: List.empty @>
+        // h <@ Map @>
+        // h <@ [| 1 |] @>
+        // h <@ Array.Parallel.tryFind @>
+        // h <@ Seq.head @>
+        // h <@ Seq.delay @>
+        // h <@ Seq.countBy @>
+        // h <@ Microsoft.FSharp.Collections.HashIdentity.FromFunctions @>
+        // h <@ List.reduce @>
 
         0