WPF - Add missing docs

NickvisionApps · Oct 6, 2023 · d109e76 · d109e76
1 parent 118f9e3
commit d109e76
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/Examples/WPF/Controls/MPVControl.xaml.cs b/Examples/WPF/Controls/MPVControl.xaml.cs
@@ -3,11 +3,18 @@
 
 namespace Nickvision.MPVSharp.Examples.WPF.Controls;
 
+/// <summary>
+/// MPV WPF Control.
+/// Embedded window is created and MPV window is connected to it (see <see cref="MPVHwndHost"/>).
+/// </summary>
 public partial class MPVControl : UserControl
 {
     private Client _client;
     private MPVHwndHost _hwndHost;
 
+    /// <summary>
+    /// Constructs MPVControl
+    /// </summary>
     public MPVControl()
     {
         InitializeComponent();
@@ -19,11 +26,18 @@ public MPVControl()
         AddChild(_hwndHost);
     }
 
+    /// <summary>
+    /// Loads and plays file from path or URL
+    /// </summary>
+    /// <param name="url">Path or URL</param>
     public void Load(string url)
     {
         _client.LoadFile(url);
         _client.SetProperty("pause", false);
     }
 
+    /// <summary>
+    /// Toggles pause
+    /// </summary>
     public void CyclePause() => _client.CyclePause();
 }
diff --git a/Examples/WPF/Views/MainWindow.xaml.cs b/Examples/WPF/Views/MainWindow.xaml.cs
@@ -9,11 +9,19 @@ namespace Nickvision.MPVSharp.Examples.WPF.Views;
 /// </summary>
 public partial class MainWindow : Window
 {
+    /// <summary>
+    /// Constructs MainWindow
+    /// </summary>
     public MainWindow()
     {
         InitializeComponent();
     }
 
+    /// <summary>
+    /// Occurs when Open Video File button was clicked
+    /// </summary>
+    /// <param name="sender">Sender</param>
+    /// <param name="e">RoutedEventArgs</param>
     private void OnOpenVideo(object sender, RoutedEventArgs e)
     {
         var openFileDialog = new OpenFileDialog()
@@ -28,11 +36,31 @@ private void OnOpenVideo(object sender, RoutedEventArgs e)
         OnLoadVideo(sender, e);
     }
 
+    /// <summary>
+    /// Occurs when Exit action was activated
+    /// </summary>
+    /// <param name="sender">Sender</param>
+    /// <param name="e">RoutedEventArgs</param>
     private void OnExit(object sender, RoutedEventArgs e) => Close();
 
+    /// <summary>
+    /// Occurs when Load Video button was clicked
+    /// </summary>
+    /// <param name="sender">Sender</param>
+    /// <param name="e">RoutedEventArgs</param>
     private void OnLoadVideo(object sender, RoutedEventArgs e) => MPV.Load(TxtUrl.Text);
 
+    /// <summary>
+    /// Occurs when Pause button aws clicked
+    /// </summary>
+    /// <param name="sender">Sender</param>
+    /// <param name="e">RoutedEventArgs</param>
     private void OnPause(object sender, RoutedEventArgs e) => MPV.CyclePause();
 
+    /// <summary>
+    /// Occurs when About action was activated
+    /// </summary>
+    /// <param name="sender">Sender</param>
+    /// <param name="e">RoutedEventArgs</param>
     private void OnAbout(object sender, RoutedEventArgs e) => MessageBox.Show("WPF MPV# Example", "About", MessageBoxButton.OK, MessageBoxImage.Information, MessageBoxResult.OK);
 }