Document Input.Common

src/Input/Silk.NET.Input.Common/Axis.cs

@@ -5,11 +5,26 @@
 
 namespace Silk.NET.Input.Common
 {
+    /// <summary>
+    /// Represents an axis on a joystick.
+    /// </summary>
     public struct Axis
     {
+        /// <summary>
+        /// The index of this axis, used to determine which axis it is.
+        /// </summary>
         public int Index { get; }
+
+        /// <summary>
+        /// The position of this axis.
+        /// </summary>
         public float Position { get; }
 
+        /// <summary>
+        /// Creates a new instance of the Axis struct.
+        /// </summary>
+        /// <param name="index">The index of the new axis.</param>
+        /// <param name="position">The position of the new axis.</param>
         public Axis(int index, float position)
         {
             Index = index;

src/Input/Silk.NET.Input.Common/Button.cs

@@ -5,10 +5,24 @@
 
 namespace Silk.NET.Input.Common
 {
+    /// <summary>
+    /// Represents a joystick button.
+    /// </summary>
     public struct Button
     {
+        /// <summary>
+        /// The name of this button. Only guaranteed to be valid if this comes from an <see cref="IGamepad"/>.
+        /// </summary>
         public ButtonName Name { get; }
+
+        /// <summary>
+        /// The index of this button. Use this if this button comes from an <see cref="IJoystick"/>.
+        /// </summary>
         public int Index { get; }
+
+        /// <summary>
+        /// Whether or not this button is currently pressed.
+        /// </summary>
         public bool Pressed { get; }
 
         public Button(ButtonName name, int index, bool pressed)

src/Input/Silk.NET.Input.Common/Hat.cs

@@ -5,11 +5,26 @@
 
 namespace Silk.NET.Input.Common
 {
+    /// <summary>
+    /// Represents a joystick hat, a D-Pad.
+    /// </summary>
     public struct Hat
     {
+        /// <summary>
+        /// The index of this hat.
+        /// </summary>
         public int Index { get; }
+
+        /// <summary>
+        /// The position of this hat.
+        /// </summary>
         public Position2D Position { get; }
 
+        /// <summary>
+        /// Creates a new instance of the Hat struct.
+        /// </summary>
+        /// <param name="index">The index of the hat.</param>
+        /// <param name="position">The position of the hat.</param>
         public Hat(int index, Position2D position)
         {
             Index = index;

src/Input/Silk.NET.Input.Common/ScrollWheel.cs

@@ -5,11 +5,26 @@
 
 namespace Silk.NET.Input.Common
 {
+    /// <summary>
+    /// Represents a scroll wheel.
+    /// </summary>
     public struct ScrollWheel
     {
+        /// <summary>
+        /// The X position of the scroll wheel.
+        /// </summary>
         public float X { get; }
+
+        /// <summary>
+        /// The Y position of the scroll wheel.
+        /// </summary>
         public float Y { get; }
 
+        /// <summary>
+        /// Creates a new instance of the scroll wheel struct.
+        /// </summary>
+        /// <param name="x">The X position of the scroll wheel.</param>
+        /// <param name="y">The Y position of the scroll wheel.</param>
         public ScrollWheel(float x, float y)
         {
             X = x;

src/Input/Silk.NET.Input.Common/Trigger.cs

@@ -5,11 +5,26 @@
 
 namespace Silk.NET.Input.Common
 {
+    /// <summary>
+    /// Represents a trigger.
+    /// </summary>
     public struct Trigger
     {
+        /// <summary>
+        /// The index of this trigger.
+        /// </summary>
         public int Index { get; }
+
+        /// <summary>
+        /// The position of this trigger; how far down it's currently pressed.
+        /// </summary>
         public float Position { get; }
 
+        /// <summary>
+        /// Creates a new instance of the Trigger struct.
+        /// </summary>
+        /// <param name="index">The index of this trigger.</param>
+        /// <param name="position">The position of this trigger.</param>
         public Trigger(int index, float position)
         {
             Index = index;