Added documentation to the DesktopMagicPluginAPI

This commit is contained in:
Stone-Red-Code
2021-08-14 21:19:03 +02:00
parent 883cc3a2fb
commit f05b5783ba
108 changed files with 1107 additions and 103 deletions
@@ -2,12 +2,26 @@
namespace DesktopMagicPluginAPI.Inputs
{
/// <summary>
/// Represents a up-down control.
/// </summary>
public class IntegerUpDown : Element
{
private int _value;
/// <summary>
/// Gets or sets the maximum value for the <see cref="IntegerUpDown"/> element.
/// </summary>
public int Maximum { get; }
/// <summary>
/// Gets or sets the minimum value for the <see cref="IntegerUpDown"/> element.
/// </summary>
public int Minimum { get; }
/// <summary>
/// Gets or sets the value assigned to the <see cref="IntegerUpDown"/> element.
/// </summary>
public int Value
{
get => _value;
@@ -21,6 +35,13 @@ namespace DesktopMagicPluginAPI.Inputs
}
}
/// <summary>
/// Initializes a new instance of the <see cref="IntegerUpDown"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
/// </summary>
/// <param name="min">The maximum value for the <see cref="IntegerUpDown"/> element.</param>
/// <param name="max">The minimum value for the <see cref="IntegerUpDown"/> element.</param>
/// <param name="value">The value assigned to the <see cref="IntegerUpDown"/> element.</param>
/// <exception cref="ArgumentException"></exception>
public IntegerUpDown(int min, int max, int value = 0)
{
if (min < 0)