From 2f84f31658914ef824e33ff1f935008b8518fc9c Mon Sep 17 00:00:00 2001
From: bvenn <venn@bio.uni-kl.de>
Date: Sun, 23 Jun 2024 20:33:33 +0200
Subject: [PATCH] add GLM docu to solution update GLM XML comments

---
 FSharp.Stats.sln                          |  1 +
 docs/GeneralisedLinearModels.fsx          |  2 +-
 src/FSharp.Stats/Algebra/LinearAlgebra.fs | 28 ++++++++++++++---------
 3 files changed, 19 insertions(+), 12 deletions(-)

diff --git a/FSharp.Stats.sln b/FSharp.Stats.sln
index bc6834aa..ff90e893 100644
--- a/FSharp.Stats.sln
+++ b/FSharp.Stats.sln
@@ -65,6 +65,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{23F9FB2E-6
 		docs\Normalization.fsx = docs\Normalization.fsx
 		docs\ML.fsx = docs\ML.fsx
 		docs\Testing.fsx = docs\Testing.fsx
+		docs\GeneralisedLinearModels.fsx = docs\GeneralisedLinearModels.fsx
 		docs\_template.html = docs\_template.html
 		docs\_template.ipynb = docs\_template.ipynb
 	EndProjectSection
diff --git a/docs/GeneralisedLinearModels.fsx b/docs/GeneralisedLinearModels.fsx
index b8955ceb..d9fd490d 100644
--- a/docs/GeneralisedLinearModels.fsx
+++ b/docs/GeneralisedLinearModels.fsx
@@ -1,7 +1,7 @@
 
 (** 
 ---
-title: GLM Documentation
+title: GLM
 index: 24
 category: Documentation
 categoryindex: 0
diff --git a/src/FSharp.Stats/Algebra/LinearAlgebra.fs b/src/FSharp.Stats/Algebra/LinearAlgebra.fs
index 8825450c..97cd1ac5 100644
--- a/src/FSharp.Stats/Algebra/LinearAlgebra.fs
+++ b/src/FSharp.Stats/Algebra/LinearAlgebra.fs
@@ -219,8 +219,14 @@ module LinearAlgebra =
         //                    else LinearAlgebraManaged.QR a
         LinearAlgebraManaged.QR a
 
-    /// Performs QR decomposition using an alternative algorithm.
-    /// Returns the orthogonal matrix Q and the upper triangular matrix R.
+    /// <summary>Performs QR decomposition using an alternative algorithm.</summary>
+    /// <remarks></remarks>
+    /// <param name="A">input matrix</param>
+    /// <returns>Returns the orthogonal matrix Q and the upper triangular matrix R.</returns>
+    /// <example>
+    /// <code>
+    /// </code>
+    /// </example>
     let qrAlternative (A: Matrix<float>) =
         let m: int = A.NumRows
         let n: int = A.NumCols
@@ -266,15 +272,15 @@ module LinearAlgebra =
 
         q, r
 
-    /// Solves a linear system of equations using QR decomposition.
-    /// 
-    /// Parameters:
-    ///   - A: The coefficient matrix of the linear system.
-    ///   - t: The target vector of the linear system.
-    /// 
-    /// Returns:
-    ///   - mX: The solution vector of the linear system.
-    ///   - r: The upper triangular matrix obtained from QR decomposition.
+    /// <summary>Solves a linear system of equations using QR decomposition.</summary>
+    /// <remarks></remarks>
+    /// <param name="A">The coefficient matrix of the linear system</param>
+    /// <param name="t">The target vector of the linear system</param>
+    /// <returns>mX: The solution vector of the linear system; r: The upper triangular matrix obtained from QR decomposition.</returns>
+    /// <example>
+    /// <code>
+    /// </code>
+    /// </example>
     let solveLinearQR (A: Matrix<float>) (t: Vector<float>) =
         let m = A.NumRows
         let n = A.NumCols