Document wifi network struct for sorting

adafruit · Nov 21, 2024 · a6b68cd · a6b68cd
1 parent bec682e
commit a6b68cd
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 25 deletions.
diff --git a/src/network_interfaces/Wippersnapper_AIRLIFT.h b/src/network_interfaces/Wippersnapper_AIRLIFT.h
@@ -103,14 +103,14 @@ class Wippersnapper_AIRLIFT : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  /**********************************************************/
+  /****************************************************************/
   /*!
-  @brief  a structure to hold network information
+  @brief  a structure to hold network information for sorting
   */
-  /**********************************************************/
+  /****************************************************************/
   struct WiFiNetwork {
-    char ssid[33]; // Maximum SSID length is 32 characters + null terminator
-    int rssi;
+    char ssid[33]; /*!< SSID (Max 32 characters + null terminator */
+    int rssi;      /*!< Received Signal Strength Indicator */
   };
 
   /*******************************************************************/

diff --git a/src/network_interfaces/Wippersnapper_ESP32.h b/src/network_interfaces/Wippersnapper_ESP32.h
@@ -92,14 +92,14 @@ class Wippersnapper_ESP32 : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  /**********************************************************/
+  /****************************************************************/
   /*!
-  @brief  a structure to hold network information
+  @brief  a structure to hold network information for sorting
   */
-  /**********************************************************/
+  /****************************************************************/
   struct WiFiNetwork {
-    char ssid[33]; // Maximum SSID length is 32 characters + null terminator
-    int rssi;
+    char ssid[33]; /*!< SSID (Max 32 characters + null terminator */
+    int rssi;      /*!< Received Signal Strength Indicator */
   };
 
   /*******************************************************************/

diff --git a/src/network_interfaces/Wippersnapper_ESP8266.h b/src/network_interfaces/Wippersnapper_ESP8266.h
@@ -115,14 +115,14 @@ class Wippersnapper_ESP8266 : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  /**********************************************************/
+  /****************************************************************/
   /*!
-  @brief  a structure to hold network information
+  @brief  a structure to hold network information for sorting
   */
-  /**********************************************************/
+  /****************************************************************/
   struct WiFiNetwork {
-    char ssid[33]; // Maximum SSID length is 32 characters + null terminator
-    int rssi;
+    char ssid[33]; /*!< SSID (Max 32 characters + null terminator */
+    int rssi;      /*!< Received Signal Strength Indicator */
   };
 
   /*******************************************************************/

diff --git a/src/network_interfaces/Wippersnapper_WIFININA.h b/src/network_interfaces/Wippersnapper_WIFININA.h
@@ -111,14 +111,14 @@ class Wippersnapper_WIFININA : public Wippersnapper {
     strlcpy(WS._config.network.pass, _pass, sizeof(WS._config.network.pass));
   }
 
-  /**********************************************************/
+  /****************************************************************/
   /*!
-  @brief  a structure to hold network information
+  @brief  a structure to hold network information for sorting
   */
-  /**********************************************************/
+  /****************************************************************/
   struct WiFiNetwork {
-    char ssid[33]; // Maximum SSID length is 32 characters + null terminator
-    int rssi;
+    char ssid[33]; /*!< SSID (Max 32 characters + null terminator */
+    int rssi;      /*!< Received Signal Strength Indicator */
   };
 
   /*******************************************************************/

diff --git a/src/network_interfaces/ws_networking_pico.h b/src/network_interfaces/ws_networking_pico.h
@@ -94,14 +94,14 @@ class ws_networking_pico : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  /**********************************************************/
+  /****************************************************************/
   /*!
-  @brief  a structure to hold network information
+  @brief  a structure to hold network information for sorting
   */
-  /**********************************************************/
+  /****************************************************************/
   struct WiFiNetwork {
-    char ssid[33]; // Maximum SSID length is 32 characters + null terminator
-    int rssi;
+    char ssid[33]; /*!< SSID (Max 32 characters + null terminator */
+    int rssi;      /*!< Received Signal Strength Indicator */
   };
 
   /*******************************************************************/