Update all model classes to Electron API 39.2

Author: softworkz

src/ElectronNET.API/API/Entities/AboutPanelOptions.cs

@@ -1,8 +1,11 @@
-namespace ElectronNET.API.Entities
+using System.Runtime.Versioning;
+
+namespace ElectronNET.API.Entities
 {
     /// <summary>
     /// About panel options.
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
     public class AboutPanelOptions
     {
         /// <summary>
@@ -21,28 +24,35 @@ public class AboutPanelOptions
         public string Copyright { get; set; }
 
         /// <summary>
-        /// The app's build version number.
+        /// The app's build version number (macOS).
         /// </summary>
+        [SupportedOSPlatform("macos")]
         public string Version { get; set; }
 
         /// <summary>
-        /// Credit information.
+        /// Credit information (macOS, Windows).
         /// </summary>
+        [SupportedOSPlatform("macos")]
+        [SupportedOSPlatform("windows")]
         public string Credits { get; set; }
 
         /// <summary>
-        /// List of app authors.
+        /// List of app authors (Linux).
         /// </summary>
+        [SupportedOSPlatform("linux")]
         public string[] Authors { get; set; }
 
         /// <summary>
-        /// The app's website.
+        /// The app's website (Linux).
         /// </summary>
+        [SupportedOSPlatform("linux")]
         public string Website { get; set; }
 
         /// <summary>
-        /// Path to the app's icon. On Linux, will be shown as 64x64 pixels while retaining aspect ratio.
+        /// Path to the app's icon in a JPEG or PNG file format. On Linux, will be shown as 64x64 pixels while retaining aspect ratio. On Windows, a 48x48 PNG will result in the best visual quality.
         /// </summary>
+        [SupportedOSPlatform("linux")]
+        [SupportedOSPlatform("windows")]
         public string IconPath { get; set; }
     }
 }

src/ElectronNET.API/API/Entities/AddRepresentationOptions.cs

@@ -1,32 +1,35 @@
+using System.Text.Json.Serialization;
+
 namespace ElectronNET.API.Entities
 {
     /// <summary>
     /// 
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
     public class AddRepresentationOptions
     {
         /// <summary>
-        /// Gets or sets the width
+        /// Gets or sets the width in pixels. Defaults to 0. Required if a bitmap buffer is specified as <see cref="Buffer"/>.
         /// </summary>
         public int? Width { get; set; }
 
         /// <summary>
-        /// Gets or sets the height
+        /// Gets or sets the height in pixels. Defaults to 0. Required if a bitmap buffer is specified as <see cref="Buffer"/>.
         /// </summary>
         public int? Height { get; set; }
 
         /// <summary>
-        /// Gets or sets the scalefactor
+        /// Gets or sets the image scale factor. Defaults to 1.0.
         /// </summary>
         public float ScaleFactor { get; set; } = 1.0f;
 
         /// <summary>
-        /// Gets or sets the buffer
+        /// Gets or sets the buffer containing the raw image data.
         /// </summary>
         public byte[] Buffer { get; set; }
 
         /// <summary>
-        /// Gets or sets the dataURL
+        /// Gets or sets the data URL containing a base 64 encoded PNG or JPEG image.
         /// </summary>
         public string DataUrl { get; set; }
     }

src/ElectronNET.API/API/Entities/AppDetailsOptions.cs

@@ -1,32 +1,36 @@
-namespace ElectronNET.API.Entities
+using System.Runtime.Versioning;
+
+namespace ElectronNET.API.Entities
 {
     /// <summary>
     /// 
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
+    [SupportedOSPlatform("windows")]
     public class AppDetailsOptions
     {
         /// <summary>
-        /// Window’s App User Model ID. It has to be set, otherwise the other options will have no effect.
+        /// Window's App User Model ID. It has to be set, otherwise the other options will have no effect.
         /// </summary>
         public string AppId { get; set; }
 
         /// <summary>
-        /// Window’s Relaunch Icon.
+        /// Window's relaunch icon resource path.
         /// </summary>
         public string AppIconPath { get; set; }
 
         /// <summary>
-        /// Index of the icon in appIconPath. Ignored when appIconPath is not set. Default is 0.
+        /// Index of the icon in <see cref="AppIconPath"/>. Ignored when <see cref="AppIconPath"/> is not set. Default is 0.
         /// </summary>
         public int AppIconIndex { get; set; }
 
         /// <summary>
-        /// Window’s Relaunch Command.
+        /// Window's relaunch command.
         /// </summary>
         public string RelaunchCommand { get; set; }
 
         /// <summary>
-        /// Window’s Relaunch Display Name.
+        /// Window's relaunch display name.
         /// </summary>
         public string RelaunchDisplayName { get; set; }
     }

src/ElectronNET.API/API/Entities/AutoResizeOptions.cs

@@ -5,6 +5,7 @@ namespace ElectronNET.API.Entities
     /// <summary>
     /// 
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
     public class AutoResizeOptions
     {
         /// <summary>

src/ElectronNET.API/API/Entities/BitmapOptions.cs

@@ -3,10 +3,11 @@
     /// <summary>
     /// 
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
     public class BitmapOptions
     {
         /// <summary>
-        /// Gets or sets the scale factor
+        /// The image scale factor. Defaults to 1.0.
         /// </summary>
         public float ScaleFactor { get; set; } = 1.0f;
     }

src/ElectronNET.API/API/Entities/Blob.cs

@@ -3,6 +3,7 @@
     /// <summary>
     /// 
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
     public class Blob : IPostData
     {
         /// <summary>

src/ElectronNET.API/API/Entities/BrowserViewConstructorOptions.cs

@@ -3,23 +3,26 @@
     /// <summary>
     /// 
     /// </summary>
+    /// <remarks>Up-to-date with Electron API 39.2</remarks>
     public class BrowserViewConstructorOptions
     {
         /// <summary>
-        /// See BrowserWindow.
+        /// Gets or sets the web preferences for the view (see WebPreferences).
         /// </summary>
         public WebPreferences WebPreferences { get; set; }
 
         /// <summary>
-        /// A proxy to set on creation in the format host:port.
+        /// Gets or sets a proxy to use on creation in the format host:port.
         /// The proxy can be alternatively set using the BrowserView.WebContents.SetProxyAsync function.
         /// </summary>
+        /// <remarks>This is custom shortcut. Not part of the Electron API.</remarks>
         public string Proxy { get; set; }
 
         /// <summary>
-        /// The credentials of the Proxy in the format username:password.
+        /// Gets or sets the credentials of the proxy in the format username:password.
         /// These will only be used if the Proxy field is also set.
         /// </summary>
+        /// <remarks>This is custom shortcut. Not part of the Electron API.</remarks>
         public string ProxyCredentials { get; set; }
     }
 }