Doxygen comments for compareByRSSI

adafruit · Nov 14, 2024 · 36453d1 · 36453d1
1 parent 28296a1
commit 36453d1
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 10 deletions.
diff --git a/src/network_interfaces/Wippersnapper_AIRLIFT.h b/src/network_interfaces/Wippersnapper_AIRLIFT.h
@@ -103,13 +103,26 @@ class Wippersnapper_AIRLIFT : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  // Define a structure to hold network information
+  /**********************************************************/
+  /*!
+  @brief  a structure to hold network information
+  */
+  /**********************************************************/
   struct WiFiNetwork {
     char ssid[33]; // Maximum SSID length is 32 characters + null terminator
     int rssi;
   };
 
-  // Comparison function to sort by RSSI in descending order
+  /*******************************************************************/
+  /*!
+  @brief  Comparison function to sort by RSSI in descending order
+  @param  a
+          WiFiNetwork object
+  @param  b
+          WiFiNetwork object
+  @returns True if a.rssi > b.rssi
+  */
+  /*******************************************************************/
   bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
     return a.rssi > b.rssi;
   }

diff --git a/src/network_interfaces/Wippersnapper_ESP32.h b/src/network_interfaces/Wippersnapper_ESP32.h
@@ -92,13 +92,26 @@ class Wippersnapper_ESP32 : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  // Define a structure to hold network information
+  /**********************************************************/
+  /*!
+  @brief  a structure to hold network information
+  */
+  /**********************************************************/
   struct WiFiNetwork {
     char ssid[33]; // Maximum SSID length is 32 characters + null terminator
     int rssi;
   };
 
-  // Comparison function to sort by RSSI in descending order
+  /*******************************************************************/
+  /*!
+  @brief  Comparison function to sort by RSSI in descending order
+  @param  a
+          WiFiNetwork object
+  @param  b
+          WiFiNetwork object
+  @returns True if a.rssi > b.rssi
+  */
+  /*******************************************************************/
   bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
     return a.rssi > b.rssi;
   }

diff --git a/src/network_interfaces/Wippersnapper_ESP8266.h b/src/network_interfaces/Wippersnapper_ESP8266.h
@@ -115,13 +115,26 @@ class Wippersnapper_ESP8266 : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  // Define a structure to hold network information
+  /**********************************************************/
+  /*!
+  @brief  a structure to hold network information
+  */
+  /**********************************************************/
   struct WiFiNetwork {
     char ssid[33]; // Maximum SSID length is 32 characters + null terminator
     int rssi;
   };
 
-  // Comparison function to sort by RSSI in descending order
+  /*******************************************************************/
+  /*!
+  @brief  Comparison function to sort by RSSI in descending order
+  @param  a
+          WiFiNetwork object
+  @param  b
+          WiFiNetwork object
+  @returns True if a.rssi > b.rssi
+  */
+  /*******************************************************************/
   bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
     return a.rssi > b.rssi;
   }

diff --git a/src/network_interfaces/Wippersnapper_WIFININA.h b/src/network_interfaces/Wippersnapper_WIFININA.h
@@ -111,13 +111,26 @@ class Wippersnapper_WIFININA : public Wippersnapper {
     strlcpy(WS._config.network.pass, _pass, sizeof(WS._config.network.pass));
   }
 
-  // Define a structure to hold network information
+  /**********************************************************/
+  /*!
+  @brief  a structure to hold network information
+  */
+  /**********************************************************/
   struct WiFiNetwork {
     char ssid[33]; // Maximum SSID length is 32 characters + null terminator
     int rssi;
   };
 
-  // Comparison function to sort by RSSI in descending order
+  /*******************************************************************/
+  /*!
+  @brief  Comparison function to sort by RSSI in descending order
+  @param  a
+          WiFiNetwork object
+  @param  b
+          WiFiNetwork object
+  @returns True if a.rssi > b.rssi
+  */
+  /*******************************************************************/
   bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
     return a.rssi > b.rssi;
   }

diff --git a/src/network_interfaces/ws_networking_pico.h b/src/network_interfaces/ws_networking_pico.h
@@ -94,13 +94,26 @@ class ws_networking_pico : public Wippersnapper {
     _pass = WS._config.network.pass;
   }
 
-  // Define a structure to hold network information
+  /**********************************************************/
+  /*!
+  @brief  a structure to hold network information
+  */
+  /**********************************************************/
   struct WiFiNetwork {
     char ssid[33]; // Maximum SSID length is 32 characters + null terminator
     int rssi;
   };
 
-  // Comparison function to sort by RSSI in descending order
+  /*******************************************************************/
+  /*!
+  @brief  Comparison function to sort by RSSI in descending order
+  @param  a
+          WiFiNetwork object
+  @param  b
+          WiFiNetwork object
+  @returns True if a.rssi > b.rssi
+  */
+  /*******************************************************************/
   bool static compareByRSSI(const WiFiNetwork &a, const WiFiNetwork &b) {
     return a.rssi > b.rssi;
   }