From cc5c7136049e97483adfd3c0a9b92e5ac0c0c192 Mon Sep 17 00:00:00 2001
From: Heinrich Lukas Weil <hl.weil@t-online.de>
Date: Wed, 23 Mar 2022 19:11:21 +0100
Subject: [PATCH] improve inline documentation

---
 src/LitXml/DSL.fs            | 52 +++++++++++++++++++++++-------------
 src/LitXml/ElementBuilder.fs |  7 ++++-
 src/LitXml/Operators.fs      |  4 +--
 3 files changed, 41 insertions(+), 22 deletions(-)

diff --git a/src/LitXml/DSL.fs b/src/LitXml/DSL.fs
index d9e44d9..0e74456 100644
--- a/src/LitXml/DSL.fs
+++ b/src/LitXml/DSL.fs
@@ -7,46 +7,60 @@ open Expression
 [<AutoOpen>]
 type DSL =
 
+    /// Create an xml element with given name
     static member inline elem name = ElementBuilder(name)
     
+    /// Create an xml attriubte with given name and value
     static member inline attr name value : Attr = 
         ok (fun tb ->
             tb.WriteAttributeString(name, string value)
         )
     
-    static member inline value (s: 'a when 'a :> System.IEquatable<'a>) : Value =
+    /// Create an xml value from the given value
+    static member inline value (s : string) : Value =
         ok (fun tb -> 
-            tb.WriteString(string s)
-        )
+            tb.WriteString(s)
+        )    
+
+    /// Create an xml value from the given value
+    static member inline value<'T when 'T :> System.IFormattable> (v : 'T) : Value =
+        ok (fun tb -> 
+            tb.WriteString(v.ToString())
+        ) 
 
-    static member inline value (s : Expr<'a> when 'a :> System.IEquatable<'a>) : Value =
+    /// Create an ok xml value from the given value expression if it succedes. Else returns a missing required.
+    static member inline value (s : Quotations.Expr<string>) : Value =
         try 
-            let value = eval<'a> s
-            let f = (fun (sb : XmlWriter) -> 
-                sb.WriteString(string value)
-            )
-            ok f            
+            let s = Expression.eval<string> s
+            ok (fun tb -> 
+                tb.WriteString(s)
+            )              
         with
         | err -> MissingRequired([err.Message])
-        
-        
+
+    /// Create an ok xml value from the given value expression if it succedes. Else returns a missing required.
+    static member inline value (s : Quotations.Expr<'a> when 'a :> System.IFormattable) : Value =
+        try 
+            let v = Expression.eval<'a> s
+            ok (fun tb -> 
+                tb.WriteString(v.ToString())
+            )            
+        with
+        | err -> MissingRequired([err.Message])
+
+    /// Transforms any given xml element to an ok.
     static member opt (elem : Element) = 
         match elem with
         | Ok (f,messages) -> elem
         | MissingOptional (messages) -> Ok((fun tb -> ()),messages)
         | MissingRequired (messages) -> Ok((fun tb -> ()),messages)
 
+    /// Transforms any given xml element expression to an ok.
     static member opt (elem : Expr<Element>) = 
         try 
             let elem = eval<Element> elem
-            match elem with
-            | Ok (f,messages) -> elem
-            | MissingOptional (messages) -> Ok((fun tb -> ()),messages)
-            | MissingRequired (messages) -> Ok((fun tb -> ()),messages)
+            DSL.opt elem
         with
         | err -> 
-            let f = (fun (sb : XmlWriter) -> 
-                ()
-            )
+            let f = (fun (sb : XmlWriter) -> ())
             Ok(f,[err.Message])
-
diff --git a/src/LitXml/ElementBuilder.fs b/src/LitXml/ElementBuilder.fs
index 198ac61..5fb19e1 100644
--- a/src/LitXml/ElementBuilder.fs
+++ b/src/LitXml/ElementBuilder.fs
@@ -19,11 +19,16 @@ type ElementBuilder(name: string) =
         messages
         |> List.map (sprintf "In Element \"%s\": %s" this.Name)
 
-    member inline _.Yield(n: 'a when 'a :> System.IEquatable<'a>) = 
+    member inline _.Yield(n: 'a when 'a :> System.IFormattable) = 
         ok (fun tb ->
             tb.WriteString(string n)
         )
 
+    member inline _.Yield(s : string) = 
+        ok (fun tb ->
+            tb.WriteString(s)
+        )
+
     member inline _.Yield(n: XmlPart) = n
         
     member inline _.Yield(b: ElementBuilder) =
diff --git a/src/LitXml/Operators.fs b/src/LitXml/Operators.fs
index ea370e2..a085d61 100644
--- a/src/LitXml/Operators.fs
+++ b/src/LitXml/Operators.fs
@@ -10,7 +10,7 @@ module Operators =
     /// Required value operator
     ///
     /// If expression does fail, returns a missing required value
-    let inline (!!) (s : Expr<'a> when 'a :> System.IEquatable<'a>) : Value =
+    let inline (!!) (s : Expr<'a>) : Value =
         try 
             let value = eval<'a> s
             let f = (fun (sb : XmlWriter) -> 
@@ -23,7 +23,7 @@ module Operators =
     /// Optional value operator
     ///
     /// If expression does fail, returns a missing optional value
-    let inline (!?) (s : Expr<'a> when 'a :> System.IEquatable<'a>) : Value =
+    let inline (!?) (s : Expr<'a>) : Value =
         try 
             let value = eval<'a> s
             let f = (fun (sb : XmlWriter) ->