xml doc rewrite

lib/averages/Mgdi.cs

@@ -1,10 +1,39 @@
+using System;
 namespace QuanTAlib;
 
+/// <summary>
+/// MGDI: Modified Geometric Decay Index
+/// A moving average that uses geometric decay with a ratio-based adjustment factor.
+/// The decay rate is modified based on the ratio between current and previous values,
+/// allowing for adaptive smoothing based on price movement magnitude.
+/// </summary>
+/// <remarks>
+/// The MGDI calculation process:
+/// 1. Calculates ratio between current and previous values
+/// 2. Uses ratio to modify the geometric decay rate
+/// 3. Applies modified decay to smooth the data
+/// 4. Adjusts smoothing based on K-factor parameter
+///
+/// Key characteristics:
+/// - Geometric decay-based smoothing
+/// - Adaptive to price movement magnitude
+/// - Adjustable smoothing via K-factor
+/// - More responsive to large price changes
+/// - Maintains smoothness during small fluctuations
+///
+/// Implementation:
+///     Based on geometric decay principles with ratio-based modification
+/// </remarks>
+
 public class Mgdi : AbstractBase
 {
     private readonly int _period;
     private readonly double _kFactor;
     private double _prevMd, _p_prevMd;
+
+    /// <param name="period">The number of periods used in the MGDI calculation.</param>
+    /// <param name="kFactor">The K-factor controlling the decay rate adjustment (default 0.6).</param>
+    /// <exception cref="ArgumentOutOfRangeException">Thrown when period or kFactor is less than or equal to 0.</exception>
     public Mgdi(int period, double kFactor = 0.6)
     {
         if (period <= 0)
@@ -22,6 +51,9 @@ public class Mgdi : AbstractBase
         Init();
     }
 
+    /// <param name="source">The data source object that publishes updates.</param>
+    /// <param name="period">The number of periods used in the MGDI calculation.</param>
+    /// <param name="kFactor">The K-factor controlling the decay rate adjustment (default 0.6).</param>
     public Mgdi(object source, int period, double kFactor = 0.6) : this(period, kFactor)
     {
         var pubEvent = source.GetType().GetEvent("Pub");
@@ -67,4 +99,4 @@ public class Mgdi : AbstractBase
         IsHot = _index >= _period;
         return _prevMd;
     }
-}
+}