Improve naming + update docs

Esbob · Feb 3, 2021 · 01703a4 · 01703a4
1 parent 1e685fa
commit 01703a4
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/src/devices/QwiicButton/QwiicButton.ButtonStatus.cs b/src/devices/QwiicButton/QwiicButton.ButtonStatus.cs
@@ -10,7 +10,7 @@ namespace Iot.Device.QwiicButton
     public sealed partial class QwiicButton
     {
         /// <summary>
-        /// Returns whether the button is pressed.
+        /// Returns whether the button is pressed, i.e. pushed in.
         /// </summary>
         public bool IsPressed()
         {
@@ -19,7 +19,7 @@ public bool IsPressed()
         }
 
         /// <summary>
-        /// Returns whether the button is clicked.
+        /// Returns whether the button is clicked, i.e. pressed and released.
         /// </summary>
         public bool HasBeenClicked()
         {
@@ -30,20 +30,20 @@ public bool HasBeenClicked()
         /// <summary>
         /// Returns whether a new button status event has occurred.
         /// </summary>
-        public bool EventAvailable()
+        public bool IsEventAvailable()
         {
             var status = new StatusRegisterBitField(_registerAccess.ReadRegister<byte>(Register.ButtonStatus));
-            return status.EventAvailable;
+            return status.IsEventAvailable;
         }
 
         /// <summary>
-        /// Sets <see cref="IsPressed"/>, <see cref="HasBeenClicked"/> and <see cref="EventAvailable"/> to false.
+        /// Sets <see cref="IsPressed"/>, <see cref="HasBeenClicked"/> and <see cref="IsEventAvailable"/> to false.
         /// </summary>
         public void ClearEventBits()
         {
             var status = new StatusRegisterBitField(_registerAccess.ReadRegister<byte>(Register.ButtonStatus))
             {
-                EventAvailable = false,
+                IsEventAvailable = false,
                 HasBeenClicked = false,
                 IsPressed = false
             };

diff --git a/src/devices/QwiicButton/QwiicButton.InterruptConfiguration.cs b/src/devices/QwiicButton/QwiicButton.InterruptConfiguration.cs
@@ -84,7 +84,7 @@ public void ResetInterruptConfig()
 
             var status = new StatusRegisterBitField
             {
-                EventAvailable = false
+                IsEventAvailable = false
             };
             _registerAccess.WriteRegister(Register.ButtonStatus, status.StatusRegisterValue);
         }

diff --git a/src/devices/QwiicButton/RegisterMapping/StatusRegisterBitField.cs b/src/devices/QwiicButton/RegisterMapping/StatusRegisterBitField.cs
@@ -11,7 +11,7 @@ internal struct StatusRegisterBitField
         [Flags]
         private enum StatusRegisterBits
         {
-            EventAvailable = 1,
+            IsEventAvailable = 1,
             HasBeenClicked = 2,
             IsPressed = 4,
         }
@@ -29,14 +29,14 @@ public StatusRegisterBitField(byte statusRegisterValue)
         /// Gets set to true when a new event occurs.
         /// Must be manually set to false to clear the flag.
         /// </summary>
-        public bool EventAvailable
+        public bool IsEventAvailable
         {
-            get { return FlagsHelper.IsSet(_statusRegisterValue, StatusRegisterBits.EventAvailable); }
-            set { FlagsHelper.SetValue(ref _statusRegisterValue, StatusRegisterBits.EventAvailable, value); }
+            get { return FlagsHelper.IsSet(_statusRegisterValue, StatusRegisterBits.IsEventAvailable); }
+            set { FlagsHelper.SetValue(ref _statusRegisterValue, StatusRegisterBits.IsEventAvailable, value); }
         }
 
         /// <summary>
-        /// Gets set to true if button is pushed.
+        /// Gets set to true if button is pressed, i.e. pushed in.
         /// </summary>
         public bool IsPressed
         {
@@ -45,7 +45,7 @@ public bool IsPressed
         }
 
         /// <summary>
-        /// Gets set to true when the button gets clicked.
+        /// Gets set to true when the button gets clicked, i.e. pressed and released.
         /// Must be manually set to false to clear the flag.
         /// </summary>
         public bool HasBeenClicked