Update .cs files with new versions (+comments)

Plugins/ASP Section Example/ASP Section Example/ASP Section Example.cs

@@ -5,26 +5,32 @@
 //    This code is intended to be used as a sample and does not guarantee any particular outcome or
 //    profit of any kind. Use it at your own risk.
 //
+//    The sample demonstrates how to create and configure a custom block in Active Symbol Panel (ASP)
+//    using the cTrader Algo API.
+//
 // -------------------------------------------------------------------------------------------------
 
 using cAlgo.API;
 
 namespace cAlgo.Plugins
 {
+    // Declare the class as a plugin without requiring special access permissions.
     [Plugin(AccessRights = AccessRights.None)]
     public class ASPSectionExample : Plugin
     {
+        // This method is triggered when the plugin starts.
         protected override void OnStart()
         {
-            var block = Asp.SymbolTab.AddBlock("My title");
-            block.Index = 2;
-            block.Height = 500;
-            block.IsExpanded = true;
+            var block = Asp.SymbolTab.AddBlock("My title");  // Add a custom block to the ASP under the Symbol tab.
+
+            block.Index = 2;  // Set the position index of the block in the panel.
+            block.Height = 500;  // Define the height of the block in pixels.
+            block.IsExpanded = true;  // Make the block expanded by default.
 
-            var webView = new WebView();
-            block.Child = webView;
+            var webView = new WebView();  // Create a WebView control to display a webpage.
+            block.Child = webView;  // Adding the WebView as a child element to the block.
 
-            webView.NavigateAsync("https://ctrader.com/");
+            webView.NavigateAsync("https://ctrader.com/");  // Navigate the WebView to the cTrader website.
         }
     }
-}
+}

Plugins/ActiveFrameChanged Sample/ActiveFrameChanged Sample/ActiveFrameChanged Sample.cs

@@ -5,9 +5,10 @@
 //    This code is intended to be used as a sample and does not guarantee any particular outcome or
 //    profit of any kind. Use it at your own risk.
 //    
-//    This sample adds a new block into the ASP. The block displays the percentage difference between
-//    the current price of a symbol its price a month ago; the symbol is taken from the currently active
-//    chart frame. This is achieved by handling the ChartManager.ActiveFrameChanged event.
+//    The sample adds a new block into Active Symbol Panel (ASP). The block displays the percentage 
+//    difference between the current price of a symbol its price a month ago; the symbol is taken from 
+//    the currently active chart frame. This is achieved by handling the ChartManager.ActiveFrameChanged 
+//    event.
 //
 // -------------------------------------------------------------------------------------------------
 
@@ -19,19 +20,19 @@
 
 namespace cAlgo.Plugins
 {
+    // Declare the class as a plugin without requiring special access permissions.
     [Plugin(AccessRights = AccessRights.None)]
     public class ActiveFrameChangedSample : Plugin
     {
-
-        // Declaring the necessary UI elements
+        // Declare the necessary UI elements.
         private Grid _grid;
         private TextBlock _percentageTextBlock;
         private Frame _activeFrame;
 
+        // This method is triggered when the plugin starts.
         protected override void OnStart()
         {
-            // Initialising the grid and the TextBlock
-            // displaying the percentage difference
+            // Initialise the grid and the TextBlock displaying the percentage difference.
             _grid = new Grid(1, 1);
             _percentageTextBlock = new TextBlock 
             {
@@ -40,38 +41,36 @@ protected override void OnStart()
                 Text = "Monthly change: ",
             };
 
-            _grid.AddChild(_percentageTextBlock, 0, 0);
+            _grid.AddChild(_percentageTextBlock, 0, 0);  // Add the TextBlock to the grid at row 0, column 0.
 
-            // Initialising a new block inside the ASP
-            // and adding the grid as a child
+            // Initialise a new block inside the ASP tab and add the grid as a child.
             var block = Asp.SymbolTab.AddBlock("Monthly Change Plugin");
 
             block.Child = _grid;
 
-            // Attaching a custom handler to the
-            // ActiveFrameChanged event
+            // Attach a custom handler to the ActiveFrameChanged event.
             ChartManager.ActiveFrameChanged += ChartManager_ActiveFrameChanged;
 
         }
 
+        // This method is triggered whenever the active frame changes in the chart manager.
         private void ChartManager_ActiveFrameChanged(ActiveFrameChangedEventArgs obj)
         {
+            // Check if the new frame is a ChartFrame.
             if (obj.NewFrame is ChartFrame) 
             {
-                // Casting the Frame into a ChartFrame
+                // Cast the Frame into a ChartFrame.
                 var newChartFrame = obj.NewFrame as ChartFrame;
 
-                // Attaining market data for the symbol for which
-                // the currently active ChartFrame is opened
+                // Attain market data for the symbol for which the currently active ChartFrame is opened.
                 var dailySeries = MarketData.GetBars(TimeFrame.Daily, newChartFrame.Symbol.Name);
 
-                // Calculating the monthly change and displaying it
-                // inside the TextBlock
+                // Calculate the monthly change and display it inside the TextBlock.
                 double monthlyChange = (newChartFrame.Symbol.Bid - dailySeries.ClosePrices[dailySeries.ClosePrices.Count - 30]) / 100;
-                _percentageTextBlock.Text = $"Monthly change: {monthlyChange}";
+                _percentageTextBlock.Text = $"Monthly change: {monthlyChange}";  // Update the TextBlock with the calculated change.
             }
         }
 
 
     }        
-}
+}

Plugins/AlgoRegistry Sample/AlgoRegistry Sample/AlgoRegistry Sample.cs

@@ -5,31 +5,33 @@
 //    This code is intended to be used as a sample and does not guarantee any particular outcome or
 //    profit of any kind. Use it at your own risk.
 //    
-//    This sample adds a trade watch tab, and uses AlgoRegistry API to show stats about installed algo types.
+//    The sample adds a trade watch tab and uses Algo Registry API to show stats about installed algo types.
 //
 // -------------------------------------------------------------------------------------------------
 
 using cAlgo.API;
 
 namespace cAlgo.Plugins
 {
+    // Declare the class as a plugin without requiring special access permissions.
     [Plugin(AccessRights = AccessRights.None)]
     public class AlgoRegistrySample : Plugin
     {
+        // This method is triggered when the plugin starts.
         protected override void OnStart()
         {
-            var tradeWatchTab = TradeWatch.AddTab("Algo Registry");
+            var tradeWatchTab = TradeWatch.AddTab("Algo Registry");  // Add a new tab to the Trade Watch section, named "Algo Registry".
 
-            var panel = new StackPanel
+            var panel = new StackPanel  // Initialise a StackPanel to hold UI elements.
             {
-                Orientation = Orientation.Horizontal,
-                HorizontalAlignment = HorizontalAlignment.Center,
+                Orientation = Orientation.Horizontal,  // Set the panel orientation to horizontal.
+                HorizontalAlignment = HorizontalAlignment.Center,  // Centre the panel within its parent container horizontally.
             };
 
-            panel.AddChild(new AlgoStatsControl(AlgoRegistry) {Margin = 10, VerticalAlignment = VerticalAlignment.Top});
-            panel.AddChild(new AlgoTypeInfoControl(AlgoRegistry) {Margin = 10, VerticalAlignment = VerticalAlignment.Top});
+            panel.AddChild(new AlgoStatsControl(AlgoRegistry) {Margin = 10, VerticalAlignment = VerticalAlignment.Top});  // Add the AlgoStatsControl to the panel with a margin and top vertical alignment.
+            panel.AddChild(new AlgoTypeInfoControl(AlgoRegistry) {Margin = 10, VerticalAlignment = VerticalAlignment.Top});  // Add the AlgoTypeInfoControl to the panel with a margin and top vertical alignment.
 
-            tradeWatchTab.Child = panel;
+            tradeWatchTab.Child = panel;  // Set the StackPanel containing the controls as the content of the "Algo Registry" tab in the Trade Watch section.
         }
     }        
-}
+}

Plugins/AlgoRegistry Sample/AlgoRegistry Sample/AlgoStatsControl.cs

@@ -1,84 +1,94 @@
-using System.Linq;
+// -------------------------------------------------------------------------------------------------
+//
+//    This code is a cTrader Algo API example.
+//
+//    This code is intended to be used as a sample and does not guarantee any particular outcome or
+//    profit of any kind. Use it at your own risk.
+//    
+//    The sample creates a custom control that displays statistics about registered algorithms in the 
+//    platform. It shows counts for total algos, custom indicators, standard indicators, cBots and 
+//    plugins. The statistics dynamically update when algo types are installed or deleted.
+//
+// -------------------------------------------------------------------------------------------------
+
+
+using System.Linq;
 using cAlgo.API;
 
 namespace cAlgo.Plugins;
 
 public class AlgoStatsControl: CustomControl
 {
-    private const string FontFamily = "Calibri";
+    private const string FontFamily = "Calibri";  // Define a constant for the font family used in the UI.
+    private readonly AlgoRegistry _algoRegistry;  // Hold a reference to the Algo Registry for accessing algorithm data.
 
-    private readonly AlgoRegistry _algoRegistry;
-    private readonly TextBlock _algosCountTextBlock;
-    private readonly TextBlock _customIndicatorsCountTextBlock;
-    private readonly TextBlock _standardIndicatorsCountTextBlock;
-    private readonly TextBlock _botsCountTextBlock;
-    private readonly TextBlock _pluginsCountTextBlock;
+    private readonly TextBlock _algosCountTextBlock;  // TextBlock to display the total number of algorithms.
+    private readonly TextBlock _customIndicatorsCountTextBlock;  // Number of custom indicators.
+    private readonly TextBlock _standardIndicatorsCountTextBlock;  // Number of standard indicators.
+    private readonly TextBlock _botsCountTextBlock;  // Number of cBots.
+    private readonly TextBlock _pluginsCountTextBlock;  // Number of plugins.
 
+    // This method initialises the control that displays stats for installed algorithms, including cBots, custom indicators and plugins.
     public AlgoStatsControl(AlgoRegistry algoRegistry)
     {
-        _algoRegistry = algoRegistry;
-
-        var panel = new Grid(6, 2);
-
-        var titleTextBlock = GetTextBlock("Algo Stats");
-
-        titleTextBlock.HorizontalAlignment = HorizontalAlignment.Center;
-
-        panel.AddChild(titleTextBlock, 0, 0, 1, 2);
+        _algoRegistry = algoRegistry;  // Assign the provided Algo Registry instance to the private field.
 
-        panel.AddChild(GetTextBlock("Algos #"), 1, 0);
-
-        _algosCountTextBlock = GetTextBlock();
+        var panel = new Grid(6, 2);  // Create a grid with 6 rows and 2 columns for organising UI elements.
+        var titleTextBlock = GetTextBlock("Algo Stats");  // Create a title TextBlock with the text "Algo Stats".
+        titleTextBlock.HorizontalAlignment = HorizontalAlignment.Center;  // Centre the title horizontally.       
+        panel.AddChild(titleTextBlock, 0, 0, 1, 2);  // Add the title to the first row, spanning both columns.
 
-        panel.AddChild(_algosCountTextBlock, 1, 1);
+        // Add a label and its corresponding TextBlock for "Algos #" to the grid.
+        panel.AddChild(GetTextBlock("Algos #"), 1, 0);  // Add a label and its corresponding TextBlock for "Algos #" to the grid.
+        _algosCountTextBlock = GetTextBlock();  // Create a TextBlock to display the total algorithm count.    
+        panel.AddChild(_algosCountTextBlock, 1, 1);  // Add the TextBlock to the grid.
 
+        // Add a label and TextBlock for "Standard Indicators #".
         panel.AddChild(GetTextBlock("Standard Indicators #"), 2, 0);
-
         _standardIndicatorsCountTextBlock = GetTextBlock();
-
         panel.AddChild(_standardIndicatorsCountTextBlock, 2, 1);
 
+        // Add a label and TextBlock for "Custom Indicators #".
         panel.AddChild(GetTextBlock("Custom Indicators #"), 3, 0);
-
         _customIndicatorsCountTextBlock = GetTextBlock();
-
         panel.AddChild(_customIndicatorsCountTextBlock, 3, 1);
 
+        // Add a label and TextBlock for "cBots #".
         panel.AddChild(GetTextBlock("cBots #"), 4, 0);
-
         _botsCountTextBlock = GetTextBlock();
-
         panel.AddChild(_botsCountTextBlock, 4, 1);
 
+        // Add a label and TextBlock for "Plugins #".
         panel.AddChild(GetTextBlock("Plugins #"), 5, 0);
-
         _pluginsCountTextBlock = GetTextBlock();
-
         panel.AddChild(_pluginsCountTextBlock, 5, 1);
 
-        AddChild(panel);
+        AddChild(panel);  // Add the grid containing all UI elements to the control.
 
-        Populate();
+        Populate();  // Populate the TextBlocks with the initial statistics.
 
-        _algoRegistry.AlgoTypeInstalled += _ => Populate();
-        _algoRegistry.AlgoTypeDeleted += _ => Populate();
+        // Subscribe to events to update statistics when an algorithm type is installed or deleted.
+        _algoRegistry.AlgoTypeInstalled += _ => Populate();  // Call Populate() on algorithm installation.
+        _algoRegistry.AlgoTypeDeleted += _ => Populate();  // Call Populate() on algorithm deletion.
     }
 
+    // This method updates the statistics displayed in the TextBlocks.
     private void Populate()
     {
-        _algosCountTextBlock.Text = _algoRegistry.Count.ToString();
-        _botsCountTextBlock.Text = _algoRegistry.Count(type => type.AlgoKind == AlgoKind.Robot).ToString();
-        _customIndicatorsCountTextBlock.Text = _algoRegistry.Count(type => type.AlgoKind == AlgoKind.CustomIndicator).ToString();
-        _standardIndicatorsCountTextBlock.Text =  _algoRegistry.Count(type => type.AlgoKind == AlgoKind.StandardIndicator).ToString();
-        _pluginsCountTextBlock.Text = _algoRegistry.Count(type => type.AlgoKind == AlgoKind.Plugin).ToString();
+        _algosCountTextBlock.Text = _algoRegistry.Count.ToString();  // Set the total algorithm count.
+        _botsCountTextBlock.Text = _algoRegistry.Count(type => type.AlgoKind == AlgoKind.Robot).ToString();  // Count cBots.
+        _customIndicatorsCountTextBlock.Text = _algoRegistry.Count(type => type.AlgoKind == AlgoKind.CustomIndicator).ToString();  // Count custom indicators.
+        _standardIndicatorsCountTextBlock.Text =  _algoRegistry.Count(type => type.AlgoKind == AlgoKind.StandardIndicator).ToString();  // Count standard indicators.
+        _pluginsCountTextBlock.Text = _algoRegistry.Count(type => type.AlgoKind == AlgoKind.Plugin).ToString();  // Count plugins.
     }
 
+    // This method creates and returns a new TextBlock with optional text.
     private TextBlock GetTextBlock(string text = null) => new()
     {
-        Margin = 3,
-        FontSize = 20,
-        FontWeight = FontWeight.Bold,
-        FontFamily = FontFamily,
-        Text = text
+        Margin = 3,  // Set a margin around the TextBlock for spacing.
+        FontSize = 20,  // Set the font size to 20.
+        FontWeight = FontWeight.Bold,  // Set the font weight to bold.
+        FontFamily = FontFamily,  // Use the defined font family.
+        Text = text  // Set the text content, if provided.
     };
-}
+}